Thanks for your interest in improving cryo!
There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with python or are the most weathered expert, we can use your help.
No contribution is too small and all contributions are valued.
This document will help you get started. Do not let the document intimidate you. It should be considered as a guide to help you navigate the process.
If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT license.
The cryo project adheres to the Rust Code of Conduct. This code of conduct describes the minimum behavior expected from all contributors.
Instances of violations of the Code of Conduct can be reported by contacting the team at storm@paradigm.xyz.
There are fundamentally three ways an individual can contribute:
- By opening an issue: For example, if you believe that you have uncovered a bug in cryo, creating a new issue in the issue tracker is the way to report it.
- By adding context: Providing additional context to existing issues, such as screenshots and code snippets to help resolve issues.
- By resolving issues: Typically this is done in the form of either demonstrating that the issue reported is not a problem after all, or more often, by opening a pull request that fixes the underlying problem, in a concrete and reviewable manner.
Anybody can participate in any stage of contribution. We urge you to participate in the discussion around bugs and participate in reviewing PRs.
If you have reviewed existing documentation and still have questions, or you are having problems, you can get help by opening a discussion. This repository comes with a discussions board where you can also ask for help. Click the "Discussions" tab at the top.
When filing a new bug report in the issue tracker, you will be presented with a basic form to fill out.
If you believe that you have uncovered a bug, please fill out the form to the best of your ability. Do not worry if you cannot answer every detail, just fill in what you can. Contributors will ask follow-up questions if something is unclear.
The most important pieces of information we need in a bug report are:
- The cryo version you are on (and that it is up to date)
- The platform you are on (Windows, macOS, an M1 Mac or Linux)
- Code snippets if this is happening in relation to testing or building code
- Concrete steps to reproduce the bug
In order to rule out the possibility of the bug being in your project, the code snippets should be as minimal as possible. It is better if you can reproduce the bug with a small snippet as opposed to an entire project!
See this guide on how to create a minimal, complete, and verifiable example.
When adding a feature request in the issue tracker, you will be presented with a basic form to fill out.
Please include as detailed of an explanation as possible of the feature you would like, adding additional context if necessary.
If you have examples of other tools that have the feature you are requesting, please include them as well.
Pull requests are the way concrete changes are made to the code, documentation, and dependencies of cryo.
Even tiny pull requests, like fixing wording, are greatly appreciated. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged.
Please also make sure that the following commands pass if you have changed the code:
If you are working on a larger feature, we encourage you to open up a draft pull request, to make sure that other contributors are not duplicating work.
If the change being proposed alters code, it is either adding new functionality to cryo, or fixing existing, broken functionality. In both of these cases, the pull request should include one or more tests to ensure that cryo does not regress in the future.
Types of tests include:
- Unit tests: Functions which have very specific tasks should be unit tested.
- Integration tests: For general purpose, far reaching functionality, integration tests should be added. The best way to add a new integration test is to look at existing ones and follow the style.
Tests that use forking must contain "fork" in their name.
It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There is no limit to the number of commits any single pull request may have, and many contributors find it easier to review changes that are split across multiple commits.
That said, if you have a number of commits that are "checkpoints" and don't represent a single logical change, please squash those together.
From within GitHub, opening a new pull request will present you with a template that should be filled out. Please try your best at filling out the details, but feel free to skip parts if you're not sure what to put.
You will probably get feedback or requests for changes to your pull request. This is a big part of the submission process, so don't be discouraged! Some contributors may sign off on the pull request right away, others may have more detailed comments or feedback. This is a necessary part of the process in order to evaluate whether the changes are correct and necessary.
Any community member can review a PR, so you might get conflicting feedback. Keep an eye out for comments from code owners to provide guidance on conflicting feedback.
Any cryo community member is welcome to review any pull request.
All contributors who choose to review and provide feedback on pull requests have a responsibility to both the project and individual making the contribution. Reviews and feedback must be helpful, insightful, and geared towards improving the contribution as opposed to simply blocking it. If there are reasons why you feel the PR should not be merged, explain what those are. Do not expect to be able to block a PR from advancing simply because you say "no" without giving an explanation. Be open to having your mind changed. Be open to working with the contributor to make the pull request better.
Reviews that are dismissive or disrespectful of the contributor or any other reviewers are strictly counter to the Code of Conduct.
When reviewing a pull request, the primary goals are for the codebase to improve and for the person submitting the request to succeed. Even if a pull request is not merged, the submitter should come away from the experience feeling like their effort was not unappreciated. Every PR from a new contributor is an opportunity to grow the community.
Do not overwhelm new contributors.
It is tempting to micro-optimize and make everything about relative performance, perfect grammar, or exact style matches. Do not succumb to that temptation.
Focus first on the most significant aspects of the change:
- Does this change make sense for cryo?
- Does this change make cryo better, even if only incrementally?
- Are there clear bugs or larger scale issues that need attending?
- Are the commit messages readable and correct? If it contains a breaking change, is it clear enough?
Note that only incremental improvement is needed to land a PR. This means that the PR does not need to be perfect, only better than the status quo. Follow-up PRs may be opened to continue iterating.
When changes are necessary, request them, do not demand them, and do not assume that the submitter already knows how to add a test or run a benchmark.
Specific performance optimization techniques, coding styles and conventions change over time. The first impression you give to a new contributor never does.
Nits (requests for small changes that are not essential) are fine, but try to avoid stalling the pull request. Most nits can typically be fixed by the cryo maintainers merging the pull request, but they can also be an opportunity for the contributor to learn a bit more about the project.
It is always good to clearly indicate nits when you comment, e.g.: Nit: change foo() to bar(). But this is not blocking.
If your comments were addressed but were not folded after new commits, or if they proved to be mistaken, please, hide them with the appropriate reason to keep the conversation flow concise and relevant.
Be aware that how you communicate requests and reviews in your feedback can have a significant impact on the success of the pull request. Yes, we may merge a particular change that makes cryo better, but the individual might just not want to have anything to do with cryo ever again. The goal is not just having good code.
If a pull request appears to be abandoned or stalled, it is polite to first check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started, either by preserving their name and e-mail address in the commit log, or by using the Author: or Co-authored-by: metadata tag in the commits.