Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 2.33 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue before submitting a change.

All changes must include appropriate unit tests in order to be merged. Please ensure all unit tests pass locally (i.e. by running bin/execute_tests) before submitting a PR for review.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md and plugin.yml files with details of changes to the interface. When adding configuration arguments to the README, make sure they are alphabetically sorted, contain the data type, and the default or example value.
  3. Bump the version numbers in .env and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of one other maintainer, or if you do not have permission to do that, you may request that the maintainer merge it for you.

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Contributing Guide, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4