The Kyoto project operates an open contributor model where anyone is welcome to contribute towards development in the form of peer review, documentation, testing and patches.
Anyone is invited to contribute without regard to technical experience, "expertise", OSS experience, age, or other concern. However, the development of protocols for cryptocurrencies demands a high-level of rigor, adversarial thinking, thorough testing and risk-minimization. Any bug may cost users real money. That being said, contributions are welcome.
All communication happens on GitHub, in the form of issues, pull requests, milestones, etc.
The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review.
To contribute a patch, the workflow is as follows:
- Fork Repository
- Create topic branch
- Commit patches
In general commits should be atomic and diffs should be easy to read. For this reason do not mix any formatting fixes or code moves with actual code changes. Further, each commit, individually, should compile and pass tests, in order to ensure git bisect and other automated tools function properly.
When adding a new feature, thought must be given to the long term technical debt. Every new feature should be covered by functional tests where possible.
When refactoring, structure your PR to make it easy to review and don't hesitate to split it into multiple small, focused PRs.
The Minimal Supported Rust Version is 1.63.0 (enforced by our CI).
Commits should cover both the issue fixed and the solution's rationale. These guidelines should be kept in mind. Commit messages should follow the "Conventional Commits 1.0.0" to make commit histories easier to read by humans and automated tools.
Commits should be signed with GPG, SSH, or S/MIME, and this will be enforced by GitHub when merging pull requests. Read more about signing commits.
To facilitate communication with other contributors, the project is making use of GitHub's "assignee" field. First check that no one is assigned and then comment suggesting that you're working on it. If someone is already assigned, don't hesitate to ask if the assigned party or previous commenter are still working on it if it has been awhile.
Use cargo fmt with the default settings to format code before committing.
Running cargo clippy --all-targets should also
pass with no lints. This is also enforced by the CI.
The use of any unsafe code blocks is completely forbidden.
Any use of clone will be scrutinized, and use of unwrap or expect is generally forbidden.
Kyoto is dependency-adverse. No additional crates will be added to the Kyoto core library, and any additional dependencies should be added behind a non-default feature.
Where possible, breaking existing APIs should be avoided. Instead, add new APIs and
use #[deprecated]
to discourage use of the old one.
Deprecated APIs are typically maintained for one release cycle. In other words, an API that has been deprecated with the 0.10 release can be expected to be removed in the 0.11 release. This allows for smoother upgrades without incurring too much technical debt inside this library.
If you deprecated an API as part of a contribution, we encourage you to "own" that API and send a follow-up to remove it as part of the next release cycle.
Anyone may participate in peer review which is expressed by comments in the pull request. Typically reviewers will review the code for obvious errors, as well as test out the patch set and opine on the technical merits of the patch. PR should be reviewed first on the conceptual level before focusing on code style or grammar fixes.
Security is a high priority of Kyoto; disclosure of security vulnerabilities helps prevent user loss of funds. In the discovery of a security vulnerability, please create an issue on GitHub.
Related to the security aspect, Kyoto developers take testing very seriously. Due to the modular nature of the project, writing new functional tests is easy and good test coverage of the codebase is an important goal.