Development
We are thrilled that you are interested in contributing to CircAdapt! Your contributions are essential to the success of the project and we are grateful for your support. Whether you are fixing bugs, adding new features, or improving the documentation, there are many ways to get involved.
Here are some guidelines to help you get started:
- Report issues
If you find a bug or have a suggestion for a new feature, please report it in the issue tracker. This helps us keep track of the work that needs to be done and ensures that no duplicates are created. When reporting an issue, be sure to provide a clear and detailed description of the problem, including steps to reproduce it. If you have a solution in mind, feel free to suggest it, but please keep in mind that it may not be the best approach for the project.
- Fork the repository
If you want to contribute code, the first step is to fork the repository on GitHub. Clone your fork locally and create a branch for your changes. This makes it easier to keep your changes separate from the main branch and ensures that your work is not lost if you need to switch to a different branch.
- Follow the style guide
When writing code for CircAdapt, it is important to follow the project’s style guide. This helps ensure that your code is consistent with the rest of the project and easier to maintain. A style guide provides guidelines for indentation, naming conventions, and other coding practices. It is a good idea to familiarize yourself with the style guide before you begin contributing.
- Write tests
When adding new features or fixing bugs, be sure to write tests that cover your changes. This helps ensure that your changes do not break existing functionality. Writing tests also makes it easier to confirm that your changes are working correctly and helps you identify any potential problems before they become major issues.
- Document your changes
Make sure to document your changes in the documentation. This will help others understand your changes and how they can use them. Clear and concise documentation is essential for ensuring that the project is accessible to everyone. If you are adding new features, be sure to provide examples and explain how they work.
- Make a pull request
Once you have completed your changes, make a pull request to the main repository. Be sure to include a detailed description of your changes and a reference to any relevant issues. This allows the project maintainers to review your changes and provide feedback. It is a good idea to include screenshots or other visual aids to help explain your changes.
- Review and feedback
Your pull request will be reviewed by the project maintainers. They may provide feedback or request additional changes. This is a normal part of the development process and helps ensure that the changes are appropriate for the project. Be open to constructive criticism and willing to make changes to your code if necessary.
- Merge and release
Once your changes have been reviewed and approved, they will be merged into the main repository and released in a new version of CircAdapt. Congratulations! Your contributions have made a difference and will be enjoyed by others.
Thank you for your contributions! We look forward to working with you to improve CircAdapt.