Thank you for your interest in contributing to our project! We welcome contributions in the form of bug reports, feature requests, documentation improvements, and code.
- Search Existing Issues: Before reporting, search the issues page to see if it has already been reported.
- Create a New Issue: If your issue is not listed, open a new issue here. Please provide a clear and descriptive title and include steps to reproduce the problem, and which versions of the Controller and Machine firmware you are using.
- Check Current Projects: Look at our project board to see if the feature is being discussed.
- Suggest a Feature: Open an issue titled "Feature Request: [Your Feature]" and explain why it would be useful.
- Open an Issue First: Before starting any development, please open an issue to discuss your proposed changes or features. This helps ensure your efforts are aligned with the project's priorities and increases the likelihood of PR acceptance.
- Get Maintainer Input: Wait for feedback or approval from the maintainers on your proposed changes. They might provide guidance or suggest an approach that fits best with the current project direction.
- Fork the Repository: Once your idea has the blessing of a maintainer, click on the "Fork" button at the top of the repository page.
- Clone your Fork: Clone your fork to your local machine using
git clone. - Create a Branch: Use
git checkout -b feature-nameto create a new branch for your changes. - Make Changes: Implement your changes.
- Test Your Changes: Ensure your changes don’t break existing functionality or introduce new bugs.
- Commit Your Changes: Write a concise and descriptive commit message.
- Push and Open a Pull Request: Push your branch to your fork and open a pull request from your branch. In the Pull Request please describe what issue you are resolving, and summarize the changes.