Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 4.44 KB

CONTRIBUTING.md

File metadata and controls

80 lines (59 loc) · 4.44 KB
Raw

Contributing

First things first, thank you for your contribution. It's easy to forget to say but I, the other contributors and all the users value the contributions made to the library; small or large all contributions are valued and welcome.

When contributing to this repository, please first discuss the change you wish to make via github issues, maybe someone has the same idea as you and just up-voting would be a contribution towards prioritisation. You may also find the work has already begun and you can help by teaming up with another contributor.

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

Pull Request Process

  1. Checkout github issues to see if your request has already been made
  2. Raise a bug or feature request using the appropriate template.
  3. Assign the task to yourself so we know your working on it, and can pitch in.
  4. Create a branch, and make it happen 😣
    • Ensure you're branch is appropriately tested, yarn run test or yarn run test:report to get coverage data
    • Linted according to the xo config with yarn lint:fix
  5. Update the README.md with details of the changes.
  6. Ensure you're using our convential commits for your commit messages
  7. Versioning and tagging are handled by Circle ci so no need to manually do anything there for the release
  8. RAISE THE PR
  9. You may merge the Pull Request in once you have the sign-off, or if you do not have permission to do that just poke the author.

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.

Attribution

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