Skip to content
This repository has been archived by the owner on Aug 21, 2023. It is now read-only.

Latest commit

 

History

History
102 lines (74 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

102 lines (74 loc) · 4.54 KB
Raw

Contributing

When contributing to this repository, please ensure that your Pull Request is linked to an issue, and that the issue is tagged with the appropriate labels (e.g. bug, enhancement, etc.). This will help us to keep track of the changes and discuss them.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

Firstly, thank you for contributing to this repository. Please ensure that you gather the following requirements to contribute:

  1. Ensure that the Pull Request is linked to an issue.
  2. Ensure that the issue is tagged with the appropriate labels (e.g. bug, enhancement, etc.).
  3. Ensure you have run locally the pipeline to generate the code in order to test your Pull Request works. See README.md for more information.
  4. Ensure that generated code is not included in the Pull Request. The generated code will be included in another Pull Request done by the pipeline.
  5. Ensure that you only include one commit in your Pull Request. If you have multiple commits, please squash them into one commit.
  6. Ensure you sign your commits. See Signing your commits for more information.

Signing your commits

To sign your commits, just add the -s flag when you commit. This will add a Signed-off-by line to your commit message. For example:

git commit -s -m "This is my commit message"

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, 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 http://contributor-covenant.org/version/1/4