First off, thank you for considering contributing to Nue! It's people like you that make Nue such a great tool.
By participating in this project, you are expected to uphold our Code of Conduct.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new issue with a clear title and detailed description of the suggested enhancement.
- Provide any relevant examples or use cases that support your suggestion.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- 2 spaces for indentation rather than tabs
- You can try running
nue lintfor style unification
By contributing, you agree that your contributions will be licensed under its MIT License.
- Set up your development environment by following our setup guide.
- Take a look at our roadmap to see where we are heading and to find areas that could use help.
- Check out the good first issues if you're looking for a place to start.
We value every contribution, no matter how small. Contributors who have made significant and valuable contributions to the Nue project are eligible to become members of the Nue-Foundation organization.
Thank you for contributing to Nue!