Contributing Guidelines adopted from Environmental Data and Governance Initiative (EDGI).

Submitting Feedback, Requests, and Bugs

This resource accepts feedback, feature requests, and bug reports by opening GitHub issues.

Submitting Code and Documentation Changes

Our process for accepting changes operates by Pull Request (PR) and has a few steps:

  1. If you haven’t submitted anything before, and you aren’t (yet!) a member of our organization, fork and clone the repo:

    $ git clone git@github.com:<your-username>/remote.git

    Organization members should clone the upsteam repo, instead of working from a personal fork:

    $ git clone git@github.com:hyphacoop/remote.git

  2. Create a new branch for the changes you want to work on. Choose a topic for your branch name that reflects the change:

    $ git checkout -b <branch-name>

  3. Create or modify the files with your changes and commit them in Git. If you are fixing a known issue, include “fixes #123” (where “123” is the issue number) in one of your commit messages to help automatically link everything together.

  4. Once your changes are ready for review, push your commits to GitHub and create a pull request (PR). If you aren’t ready for final review and just need some preliminary feedback, create the PR as a draft:

    Screenshot of PR button with “draft” option

  5. Allow others sufficient time for review and comments before merging. We make use of GitHub’s review feature to comment in-line on PRs when possible. There may be some fixes or adjustments you’ll have to make based on feedback.

    In general, we do our best to provide some feedback or review within about 3 days. (And hopefully much quicker most of the time!)

    If you have commit rights on the repo, you should merge your own PR, but have someone else review it first. Allow up to 3 days for review. If you don’t get any feedback by then, you can merge it without review.

  6. Once you have integrated comments, or waited for feedback, a member should merge your changes in.