Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

53 lines (44 loc) · 2.6 KB
Raw

Contributing to versionize

Contribution Workflow

The versionize repository uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes:

  1. Within your fork of versionize, create a branch for your contribution. Use a meaningful name.
  2. Create your contribution, meeting all contribution quality standards
  3. Create a pull request against the master branch of the versionize repository.
  4. Work with your reviewers to address any comments and obtain a minimum of 2 approvals, at least one of which must be provided by a maintainer. To update your pull request amend existing commits whenever applicable and then push the new changes to your pull request branch.
  5. Once the pull request is approved, one of the maintainers will merge it.

Request for Comments

If you just want to receive feedback for a contribution proposal, open an “RFC” (“Request for Comments”) pull request:

  1. On your fork of versionize, create a branch for the contribution you want feedback on. Use a meaningful name.
  2. Create your proposal based on the existing codebase.
  3. Create a draft pull request against the master branch of the versionize repository.
  4. Discuss your proposal with the community on the pull request page (or on any other channel). Add the conclusion(s) of this discussion to the pull request page.

Contribution Quality Standards

Most quality and style standards are enforced automatically during integration testing. Your contribution needs to meet the following standards:

  • Separate each logical change into its own commit.
  • Each commit must pass all unit & code style tests, and the full pull request must pass all integration tests.
  • Unit test coverage must increase the overall project code coverage.
  • Document all your public functions.
  • Add a descriptive message for each commit. Follow commit message best practices.
  • Document your pull requests. Include the reasoning behind each change.
  • Acknowledge versionize's Apache 2.0 license and certify that no part of your contribution contravenes this license by signing off on all your commits with git -s. Ensure that every file in your pull request has a header referring to the repository license file.