Contributing to corx¶

Thank you for considering contributing to the corx project! We appreciate your effort to improve our codebase.

Before you begin, please review our Code of Conduct to ensure a positive and inclusive environment for everyone.

Getting Started¶

Fork the corx repository on Bitbucket.
Clone your forked repository to your local machine: git clone https://bitbucket.org/your-username/corx.git
Create a new branch for your changes: git checkout -b feature-name

Make your changes and commit them:

git add .
git commit -m "Your descriptive commit message"

Push your changes to your forked repository: git push origin feature-name
Create a pull request on Bitbucket with a clear title, description, and reference to any relevant issues.

Follow the established coding style in the corx project. Adhere to any linters or coding style guides.

Ensure your changes pass existing tests. Add new tests for any new features.

Update documentation if your changes affect it. This includes README files, code comments, and other relevant documentation.

Pick up open issues or create new ones for bugs or enhancements. Discuss ideas with the community before major changes.

Maintainers will review all contributions. Be patient during the review process and address any feedback.

If you need help or have questions, reach out on Bitbucket Discussions or create an issue.

Thank you for contributing to corx! We value your time and effort.

Happy coding!