Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 4.86 KB

CONTRIBUTING.md

File metadata and controls

83 lines (54 loc) · 4.86 KB

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 making a change.

Project Standards & Processes

Commit messages

All commits should follow these rules:

  • Max length of 72 chars for a brief summary. IntelliJ/Vim/etc have settings to enforce this. Write as if the summary is preceded by 'This commit will....', e.g. 'Add save as button' vs 'Added save as button', 'Fix...' vs 'Fixed...', etc.
  • Blank line after summary.
  • Max length of 72 chars for additional descriptive text, hard wrapped.
  • Capital letters at the start of summary/sentences.
  • If the commit relates to an issue the summary should include the issue number as follows: gh-nnn Summary text.
  • No emojis.
  • This is a good guide to a good commit message.

Pull Request Process

When submiting a pull request (PR) the following rules should be observed:

  1. The PR should relate to an existing issue or issues.
  2. Name the PR in the form gh-nnn Summary text, where nnn is the issue number.
  3. Make the required code changes.
  4. Add/update any tests
  5. Commit code following the commit message standards above.
  6. Update the CHANGELOG.md with details of the changes
  7. Update any documentation in the repository, and/or in the gchq/stroom-docs repository (an additional PR will be required for this)
  8. Run a full build including integration tests to ensure it passes.
  9. Sign the GCHQ Contributor Licence Agreement
  10. Inform the project maintainers when the PR is ready to be reviewed/merged.

Coding Standards

TODO

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, 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 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.

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, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html