Thank you for considering contributing to Stellar Base! This guide will help you get started.
Before starting to work on a feature or fix, please start a discussion
on our mailing list at ~aurora/[email protected]
. You can,
alternatively, open an issue on GitHub. This will help avoid the
unfortunate situation in which your patch is rejected.
Please do not report security issues on GitHub. Send the security report
to our security mailing list at ~aurora/[email protected]
.
- Briefly explain why is this change necessary. What's the use case?
- How does the API look like?
- How do you plan to implement it?
- Describe how to reproduce the bug. Optionally include code samples.
- How do you plan to fix it?
You must sign off your Git commits to indicate that you agree to the terms of the Developer Certificate of Origin.
This can be done using the -s
flag on git commit
.
This project uses conventional commits. Before opening a Pull Request, make sure to rebase your commits in a single one.
You can send your patch by email to
~aurora/[email protected]
. Alternatively, you can open a Pull
Request on GitHub.
Document your changes in the CHANGELOG, the format is based on the Keep a Changelog format.