Radius is in an early phase of development right now. We welcome feedback in the form of issues that comes from usage and is aligned with the current scope and goals of the project.
You can find our full contributor documentation including instructions at the following links:
- How to contribute
- See "good first issues"
- Install prerequisites
- Create your first commit (full walkthrough)
- Building the repo
- Run tests
- Understanding repo organization
- Contribute to issues
- Create pull requests
- Contribute to documentation
We welcome small pull request contributions from anyone (docs improvements, bug fixes, minor features.) as long as they follow a few guidelines:
- For very minor changes like correcting a typo feel free to send a pull request. Otherwise ...
- Please start by choosing an existing issue, or opening an issue to work on.
- The maintainers will respond to your issue, please work with the maintainers to ensure that what you're doing is in scope for the project before writing any code.
- If you have any doubt whether a contribution would be valuable, feel free to ask.
The Radius project follows the Developer Certificate of Origin. This is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.
This is my commit message
Signed-off-by: Random J Developer <[email protected]>
Git even has a -s command line option to append this automatically to your commit message:
$ git commit -s -m 'This is my commit message'
Visual Studio Code has a setting, git.alwaysSignOff to automatically add a Signed-off-by line to commit messages. Search for "sign-off" in VS Code settings to find it and enable it.
This project has adopted the Contributor Covenant. For more information see CODE_OF_CONDUCT.md