Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

69 lines (41 loc) · 3.05 KB
Raw

Contributing Guidelines

We love improvements to our documentation!

Submitting Issues

The simplest way to tell us about a possible improvement is to open a new issue in the Workflow repo.

Submitting Changes Through Pull Requests

Our process for accepting changes 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:datarefuge/workflow.git

  1. 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>

  2. 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/datarefuge/workflow/pull/new/master

  3. Once your changes are ready for final review, commit your changes then modify or create your pull request (PR), assign a reviewer or ping (using "@datarefuge/workflow") those able to review and merge in PRs: @khdelphine, @dcwalk, @liblaurie or @titaniumbones.

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

  5. Once you have integrated comments, or waited for feedback, your changes should get merged in!

Incremental Changes

Note that it is better to submit incremental bite-size changes that are easier to review.

If you have in mind heavy changes, especially if they will affect the overall structure of the documentation, please discuss your plans with the other editors first.

Viewing your Changes

Documentation is built with MkDocs, a static site generator tailored to writing documentation.

Install Mkdocs with a package manager or python/pip:

$ brew install mkdocs

or

$ pip install mkdocs

Clone this repo and navigate to it, make changes to the .md files.

You can view changes via your browser at http://127.0.0.1:8000, by running the command:

$ mkdocs serve

Note: Mkdocs enforces Markdown syntax strictly, please refer to Github's Markdown guide and MkDocs guide for details.

Once a pull request has been merged into master, the gh-pages need to be regenerated by a reviewer. They do that from a up-to-date local master branch at the command line:

$ mkdocs gh-deploy

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