Welcome to the ace-sql project, and thank you for considering contributing! We appreciate your support and the time you're willing to spend helping make this project better.
To ensure a smooth and effective collaboration, please review and follow these guidelines when making contributions:
- Make sure you have a GitHub account.
- Fork the repository on GitHub.
- Clone the forked repository to your local machine.
- Create a new branch for your feature or bug fix:
git checkout -b feature-name
. - Make your changes and test them thoroughly.
- Commit your changes with a descriptive commit message.
- Push your branch to your fork on GitHub:
git push origin feature-name
.
Please note that by participating in this project, you agree to abide by our Code of Conduct. Be respectful and considerate of other contributors, and help create a welcoming and inclusive environment for all.
- You can contribute in various ways, including but not limited to:
- Reporting bugs or issues.
- Suggesting new features or improvements.
- Writing or improving documentation.
- Submitting code changes through pull requests.
- Ensure your changes are tested and do not break existing functionality.
- Write clear and descriptive commit messages.
- Pull requests should be made against the
main
branch. - If you're addressing an issue, reference it in your pull request.
- Make sure to update the documentation when necessary.
- Follow the existing code style and structure in the project.
- Use meaningful variable and function names.
- Keep your code clean and well-documented.
- Write descriptive comments where necessary.
Thank you for your contribution! Your efforts help make this project better for everyone.
If you have any questions or need clarification on anything, please feel free to reach out to us through the issue tracker.