Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

43 lines (33 loc) · 2.62 KB
Raw

Contributing Guideline

Welcome to our project, the fact that you are finding yourself looking at the contributing guidelines for this project is great, we would love for you to contribute

We want to make contributing as easy and transparent as possible, whether it's reporting a bug, submitting a fix, proposing new features or simply becoming a maintainer.

Quick Links

Getting Started

Contributions to this repo are made via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • Search for existing Issues and PRs before creating your own.
  • We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
  • If you've never contributed before, see issues that are labelled good first issue or documentation to slowly get familiar with the codebase
    • If you have any questions please ask!

Our Branching Strategy

We use GitHub Flow as our branching strategy so all changes go through pull requests

Pull request are the best way to propose changes to the codebase, and we actively welcome PRs. To submit a change:

  1. Fork the repository and create a branch from master
  2. Any code added should be tested, please add tests!
  3. Any changes that impacts contracts (func parameters or APIs), please document them
  4. All tests pass and code coverage is maintained or improved
  5. Make sure you code adheres to the linting rules
  6. Issue a pull request
    1. PRs should always be linked to an issue on the repo
    2. In the description please add as make explanation about the changes you have made
    3. We have PR template to help you describe the changes been made

Raising Issues

We would love your feedback whether there is a bug in a version of the code, share potential enhancements or ask questions, please raise a GitHub Issue

When raising an issue please provide as much information as you possibly can in order for us to help you quicker.

Code of Conduct

We take our open source community seriously. We hold ourselves and other contributors to high standards of communication. By contributing to this project, you agree to uphold our Code of Conduct