Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.87 KB

Contributing to SQLynx

Thank you for considering contributing to the SQLynx project! We welcome and appreciate contributions from the community. To make the contribution process smooth and effective, please follow these guidelines.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please follow these steps:

  1. Check for Existing Issues: Before creating a new issue, please check the Issues section to see if your issue has already been reported.
  2. Open a New Issue: If your issue is not listed, open a new issue and provide detailed information about the problem or feature request. Include:
    • A clear and descriptive title.
    • A description of the issue or feature.
    • Steps to reproduce the issue (if applicable).
    • Any relevant screenshots or logs.

Submitting Code

To submit code changes, follow these steps:

  1. Fork the Repository: Create a fork of the SQLynx repository by clicking the "Fork" button at the top right of the repository page.

  2. Clone Your Fork:

    git clone https://github.com/your-username/SQLynx.git
cd SQLynx

  3. Create a New Branch: It’s best practice to create a new branch for each feature or bug fix:

    git checkout -b your-branch-name

  4. Make Changes: Implement your changes or new feature. Be sure to write clear and concise commit messages explaining your changes.

  5. Commit Changes:

    git add .
git commit -m "Describe your changes here"

  6. Push Changes:

    git push origin your-branch-name

  7. Create a Pull Request: Go to the Pull Requests section of the repository and click "New Pull Request." Select your branch and submit the pull request. Include a clear description of your changes and why they are needed.

Code of Conduct

We ask that all contributors follow our Code of Conduct to ensure a welcoming and inclusive environment for everyone.

Contribution Guidelines

  • Be Respectful: Treat all contributors with respect and kindness. Constructive feedback is encouraged, but personal attacks and harassment are not tolerated.
  • Follow Coding Standards: Adhere to the coding standards and guidelines specified in the project. Consistent formatting and style improve code readability and maintainability.
  • Write Tests: If applicable, write tests to verify your changes. Tests help ensure code quality and prevent regressions.

Getting Help

If you have questions or need help, you can:

  • Ask a Question: Open an issue and tag it with "question" to seek assistance.
  • Join the Discussion: Participate in discussions on relevant forums or chat channels, if available.

Thank you for your contributions and support!