UNCLASSIFIED

You need to sign in or sign up before continuing.
Commit 83f88ca7 authored by Keith Becker's avatar Keith Becker
Browse files

Merge branch 'dev-contributing' into 'master'

add contributing.md

See merge request !129
parents b67dcb99 eb1b1450
# Contributing
Thanks for your interest in contributing to Launchboard!
When contributing to this repository, please first discuss the change you wish to make via issue, [The Launchboard Channel](https://chat.il2.dso.mil/platform-one/channels/topic--launchboard) on [Platform One Mattermost](https://chat.il2.dso.mil/), or any other method with the owners of this repository before making a change.
## Merge Request Process
To contribute a change:
1. Create a branch on the cloned repository.
2. Make your changes.
3. Write tests using [jest](https://jestjs.io/) for unit tests and [cypress](https://www.cypress.io) for end-to-end tests, if necessary.
4. Unit test coverage should ideally be 100% for your new code.
5. Make commits using the [Conventional Commits](https://www.conventionalcommits.org/) format. This helps with automation for changelog (future).
6. Open a merge request using one of the provided templates (if available). If this merge request is solving a preexisting issue, add the issue reference into the description of the MR.
7. During this time, ensure that all new commits are rebased into your branch so that it remains up to date with the `master` branch.
8. Wait for a maintainer of the repository (see CODEOWNERS) to approve.
9. If you have permissions to merge, you are responsible for merging. Otherwise, a project maintainer will merge the commit.
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## 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 Code of Conduct, 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment