Skip to content
SQL Aide (SQLa) Documentation

Contributors Guide

Thank you for considering contributing to SQLa (SQL Aide)! We appreciate your interest in making this project even better. By following these guidelines, you can ensure a smooth and collaborative contribution process.

Code of Conduct

Before contributing, please review and adhere to our Code of Conduct. We expect all contributors to maintain a respectful and inclusive environment for everyone involved.

Ways to Contribute

There are several ways you can contribute to SQLa:

  • Report Bugs: If you encounter any bugs or issues while using SQLa, please let us know by opening a GitHub issue. Provide a clear and detailed description of the problem, including steps to reproduce it.

  • Submit Feature Requests: If you have an idea for a new feature or enhancement, we encourage you to submit a GitHub issue. Describe the feature request and provide a clear use case for it.

  • Submit Pull Requests: If you want to contribute code changes, improvements, or new features, please submit a pull request. Ensure your code follows our coding conventions and guidelines.

Contributing Code

To contribute code to SQLa, please follow these steps:

  1. Fork the SQLa repository to your GitHub account.

  2. Clone the forked repository to your local machine.

Terminal window
git clone https://github.com/your-username/sqla.git
git checkout -b your-branch-name

  1. Make the necessary code changes, additions, or improvements.

  2. Ensure that your code follows our coding conventions and guidelines.

  3. Commit your changes with clear and descriptive commit messages.

  4. Push your changes to your forked repository.

Terminal window
git push origin your-branch-name

  1. Open a pull request in the SQLa repository. Provide a detailed description of your changes, along with any relevant information or context.

  2. Participate in the code review process by addressing any feedback or comments.

  3. Once your changes are approved, they will be merged into the main SQLa repository.

Attribution

We value and appreciate all contributions to SQLa. To give credit where it’s due, we will include your name and GitHub username (if provided) in the list of contributors in our project’s documentation.

Feedback and Support

If you have any questions, need support, or want to provide feedback, you can reach out to us through the following channels:

Thank you for your contributions and for helping make SQLa a thriving open-source project!