Skip to content

Latest commit

 

History

History
104 lines (79 loc) · 4.87 KB

CONTRIBUTING.md

File metadata and controls

104 lines (79 loc) · 4.87 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.

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

Issue process

  1. If you have a suggestion or encounter an unexpected behavior, please do not hesitate to report it by creating an issue.
  2. Before doing any "fixing" work, you might want to wait for maintainter feedback as we might disagree or consider a bug to be either out of scope or working as expected.
  3. Once the issue is mutually agreed upon, you can either propose a fix, or wait for us to do it ourselves. That might take a long time if we are too busy to take care of it immediately. However, we will strive to at least review proposed community improvements in a timely manner.

Pull Request Process

  1. Ensure any change in behavior is agreed upon with maintainers, well-documented and tested.
  2. Update the CHANGELOG with details of changes to the interface ; this includes any breaking or minor change. Add a reference to the Github issue relating to this change as exemplified in this file.
  3. Do not increase version numbers as master is always a snapshot and we will take care of the version update when we release and publish an artifact.
  4. Please understand that we cannot dedicate ourselves to always reacting immediately to any request and that thus you might have to wait a little bit before we have a chance to look at pull requests. However, we will do our best to do so in a timely manner.
  5. You understand that any code you submit falls under the license of the project.

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