Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 3.5 KB

Contributing Guidelines

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.

Pull Request Process

Before sending a Pull Request, please ensure the following things:

  • You're assigned the task to a particular issue.
  • If a relevant issue already exists , please discuss it on the issue page, and get it assigned to yourself.
  • If no relevant issue exist, please open a new issue and get it assigned to yourself.

Please process with an issue if it is assigned to you, we dont want you to waste your time and hardwork if the Pull Request isn't accepted.

When creating a Pull Request, please ensure the following things:

  • Your forked repository's main branch is up-to-date with original main repository.
  • Create a new branch from main in your forked repository and commit your changes to that branch.
  • Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)
  • Check that only the relevant files are being changed, there should be no unintended changes to the schema or dependency files

Steps to follow after opening a pull request.

  • Check the travis-ci continuous integration build once it completes.
  • This usually takes about 10 minutes ⏱, and if any tests fail you can find details in the build log.

If somehow build fails / not passing then:

  • Try to fix whatever caused it to fail if you can.
  • Ask for help if you cannot fix it. If a pull request build is failing but you have not asked for help, we will assume that you have seen the errors and are still working on them.
  • If you don't get reviewer feedback in couple of days ⏱, or you're waiting for followup, ping someone.

Code of Conduct

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.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4