Skip to content

Commit

Permalink
Adding workflow instructions to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dpslwk committed Dec 5, 2015
1 parent 81d7664 commit 4524722
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Nottingham Hackspace Rules - Draft
|docs|

http://rules.nottinghack.org.uk
This is the draft version of the new rules for nottingham hackspace


Contributing
============
Expand All @@ -14,8 +16,22 @@ The docs are built and hosted by Read The Docs http://readthedocs.org

If you wish to comment these rules please either open a `issue <https://github.com/NottingHack/rules/issues>`_ or a `pull request <https://github.com/NottingHack/rules/pulls>`_

Building Locally
================

Workflow for submitting text changes
====================================
We use pull request to suggest changes, these should be done with forks and pull requests. Once a pull request is submitted others can then discuss these changes before the are accepted into the rules.

To do a pull request start by forking this repository by clicking the fork button in the upper right corner.

Once forked github should take you to your copy of the rules, make sure your branch is set to 'rtd-draft', click onto the file for the rule you wish to edit.

You should now have a edit icon in the right hand corner (looks like a pencil), Click this and you can make your changes, at the bottom of the page is a area titled "Commit changes" Fill in the boxes with a meaningful comment about your change. Small changes and lots of commits are better than a single commit with a rewrite of the whole page.

Once you have a commit you can star a pull request, on the front page of you repository click the green 'New pull request' button , this will show a list of changes between your copy the hackspace, click the green 'Create pull request' button, add a suitable comment and click the green 'Create pull request'.


Building rendered version locally - Advanced
============================================

You will need python and to install the following dependencies

Expand Down

0 comments on commit 4524722

Please sign in to comment.