Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 2.57 KB
Raw

Contributing

Thank you for your interest in contributing to Armistice!

To contribute to this repository, here is all you need to do:

  1. Review CODE_OF_CONDUCT.md
  2. Fork the project on GitHub and create a commit adding yourself to AUTHORS.md
  3. Create one or more additional commits including your contributions, then open a pull request along with the commit adding yourself to AUTHORS.md.

Code of Conduct

First, we please ask you to review the CODE_OF_CONDUCT.md, as we would like to make this a friendly, cordial, and harassment-free project where anyone can contribute regardless of race, gender, or sexual orientation.

If you observe harassment which you do not think is being addressed, please contact us and we will seek to remedy the situation.

Add Yourself to AUTHORS.md

Before we can accept a PR, we need you to add yourself to the AUTHORS.md file, along with a statement that you are willing to license your contributions under the terms of the Apache License, Version 2.0 (included in this repository in the toplevel LICENSE file).

To do this, edit the AUTHORS.md file, inserting your name in the list of contributors (in rougly alphabetical order by last name, preferably) along with the name of the crate or armistice you are contributing to.

Commit the AUTHORS.md file alone (i.e. do not modify other files in the same commit, although it is fine to include this commit as part of your first PR to the project), and use the following commit message:

AUTHORS.md: adding [MY GITHUB USERNAME] and licensing my contributions

I, [LEGAL NAME HERE], hereby agree to license all contributions I make
to this project under the terms of the Apache License, Version 2.0.

Please replace [MY GITHUB USERNAME] with the GitHub username you are sending the PR from, including the @ symbol (e.g. @defunkt), and also replacing [LEGAL NAME HERE] with your full legal name.

See this commit for an example.

If you have concerns about including your legal name in this file but would still like to contribute, please contact us and we can discuss other potential arrangements.