-
Notifications
You must be signed in to change notification settings - Fork 0
Pull Requests
Contributions should be made via pull requests. Pull requests will be reviewed by one or more maintainers and merged when acceptable.
We ask that before contributing, please make the effort to coordinate with the maintainers of the project before submitting large or high impact PRs. This will prevent you from doing extra work that may or may not be merged.
PRs that are just submitted without any prior communication will likely be summarily closed.
While pull requests are the methodology for submitting changes to code, changes are much more likely to be accepted if they are accompanied by additional engineering work. While we don’t define this explicitly, most of these goals are accomplished through communication of the design goals and subsequent solutions. Often times, it helps to first state the problem before presenting solutions.
Typically, the best methods of accomplishing this are to submit an issue, stating the problem. This issue can include a problem statement and a checklist with requirements. If solutions are proposed, alternatives should be listed and eliminated. Even if the criteria for elimination of a solution is frivolous, say so.
Larger changes typically work best with design documents, similar to those found in Wiki. These are focused on providing context to the design at the time the feature was conceived and can inform future documentation contributions.
Make sure that new tests are added for bugs in order to catch regressions and tests with new features to exercise the new functionality that is added.
Based on containerd.io guidelines.