Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.74 KB
Raw

Contributing Guidelines

We love improvements to our tools! There are a few key ways you can help us improve our projects:

Discussing Possibilities for Data Together

We are engaging in a collaborative discussion about project aims and goals, the best place to join in is on github.com/datatogether/ and all are welcome to join our Slack chat.

Submitting Feedback, Requests, and Bugs

Submitting feedback or feature requests and reporting bugs usually begins by opening a GitHub issues

Almost all repositories have their own set of issues:

    https://github.com/datatogether/<repository-name>/issues

Some projects have additional templates or sets of questions for each issue, which you will be prompted to fill out when creating one.

Submitting Code and Documentation Changes

We have project guidelines for all of the projects hosted in our GitHub Organization, which all repositories should follow.

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>/<repository-name>.git

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

    $ git clone git@github.com:datatogether/<repository-name>.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. If you want to show other people work that isn't ready to merge in, commit your changes then create a pull request (PR) with WIP or Work In Progress in the title.

    https://github.com/datatogether/<repository-name>/pull/new/master

  4. Once your changes are ready for final review, commit your changes then modify or create your pull request (PR). Next, assign an active lead as a reviewer or ping them (using "@<username>")

  5. Allow others sufficient time for review and comments before pinging again. 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.

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

These guidelines are based on EDGI and Toronto Mesh's.