Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.17 KB
Raw

Contributing

Welcome contributors to your project then list particular contribution procedures your team follows including but not limited to the sections below.

Sample text may go like this. Welcome and thank you for your interest in contributing to project-name! Before contributing to this project, please review this document for policies and procedures which will ease the contribution and review process for everyone. If you have questions, please contact contact-method. This project adopted Inner Source model.

Issues and Feature Requests

Describe procedures or other requirements on filing issues, fixing bugs, proposing new features, etc that you have including references to roadmaps or other considerations contributors should make before submitting anything to the project team for review.

Style Guidelines

Include any code and/or documentation style guidelines, linting requirements, etc.

Pull Request Process

Give very detailed instructions on your PR procedure to ensure contributions are made in the way your teams wants/expects them. This eases the process for everyone. An example process could include the following but this should align with your team's processes.

  1. Ensure builds are still successful and tests, including any added or updated tests, pass prior to submitting the pull request.
  2. Update any documentation, user and contributor, that is impacted by your changes.
  3. Increase the version numbers in any examples and the README.md to the new version that this pull request would represent. The versioning scheme we use is SemVer.
  4. Include your change description in CHANGELOG.md file as part of pull request.
  5. You may merge the pull request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

License Information

Inform the user of the license(s) under which this project accepts and distributes contributions. If you have any license agreement or other legal requirements, include those here as well.