Skip to content

Latest commit

 

History

History
56 lines (31 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

56 lines (31 loc) · 3.06 KB

Contributing to the Project

Thanks for being interested in our project!

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests. Here are a few guidelines.

Contents

Code of Conduct

This project follows the PSDC Code of Conduct.

We take our development process seriously and hold ourselves and other contributors to high standards of communication. Please ensure adherence to the procedures outlined herein.

Getting Started

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

  • Issues should be used to report problems with the application, request a new feature, or to discuss potential changes before a PR is created.

  • PRs are always welcome and can be a quick way to get fixes or improvements integrated and/or slated for the next release.

To get started, go ahead and fork this repo. Once you've done that, there are a few things you should know before getting started:

In general, we follow the "fork-fix-pull-request" Git workflow as described here.

  1. Fork the repository to your own Github account.

  2. Clone the project to your machine.

  3. Create a branch locally with a succinct but descriptive name (e.g. your-initials/feature-you-are-working-on).

  4. Commit changes to the branch.

  5. Follow any formatting and testing guidelines specific to this repo.

  6. Push changes to your fork

  7. Open a PR in this repository. See the next section for more info.

Submitting a Pull Request

Once you're ready to submit your changes, submit a pull request into the main branch. We recommend that you open an issue to discuss your proposed changes before making a PR, but you're welcome to submit a PR without an issue so long as you ensure to include a good description of your changes.

💡 If you're looking for more info on this process, you can read all about Collaborating with issues and pull requests. Or if you prefer something more tutorial-style, check out the Hello World and Forking Projects activities on GitHub Guides.

Getting Help

We're happy to help if you get stuck or have questions. Check out the Core Team section of the README for info on how to get in touch.