Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

38 lines (30 loc) · 1.49 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before submitting a change.

Issue Tracking

Issues can be tracked via [GitHub Issues].

Pull Request Process

We encourage a fork-based workflow, where experimental branches will live in your fork until they're ready to be submitted upstream via a PR.

  1. Fork this repository.
  2. Create a new branch of off master for your work.
  3. Update the [README] to document your change. See [Readme Driven Development] (or RDD!) for more information about this workflow.
  4. Update or add a breaking test for your change.
  5. Add your change until the tests pass.
  6. Add a note about your change to the [Unreleased] section of the [CHANGELOG].
  7. Squash or rebase your commits.
  8. Create a PR back to the master branch of this repo.
  9. The repo [CODEOWNERS] will be tagged for PR review.
  10. Once your change is approved, your PR will be merged.
  11. When maintainers create a new release, your [CHANGELOG] entry will be moved from the [Unreleased] section to the section for the new version.
  12. You've done it!

[GitHub Issues]: https://github.com/timoguin/aws-org-tools-py/issues). [README]: README.md [Readme Driven Development]: https://tom.preston-werner.com/2010/08/23/readme-driven-development.html [CHANGELOG]: CHANGELOG.md [Unreleased]: CHANGELOG.md#Unreleased [CODEOWNERS]: .github/CODEOWNERS