Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
geeksareforlife committed Dec 5, 2015
1 parent 4524722 commit 38b772a
Showing 1 changed file with 28 additions and 10 deletions.
38 changes: 28 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,42 @@ This is the draft version of the new rules for nottingham hackspace

Contributing
============
The rules are written using reStructuredText for more info on the syntax please visit http://docutils.sourceforge.net/rst.html
The rules (and this README) are written using reStructuredText which is a way of formatting a plain text file whilst keeping it human-readable.

The docs are built and hosted by Read The Docs http://readthedocs.org
For more info on the reStructuredText syntax please visit http://docutils.sourceforge.net/rst.html. If you are new to this type of documentation, have a look at `the Primer <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ and `Quick reStructuredText <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_. If you have used something like this before (for example, Markdown), you should be able to get away with just the `Cheat Sheet <http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt>`_.

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>`_
The finsihed documents are built and hosted by Read The Docs http://readthedocs.org and are available at http://rules.nottinghack.org.uk. When a change is merged into this GitHub repository, the documents are automatically regenerated and available at that site in a couple of minutes.

We will use GitHub for contributions to the rules, using `issues <https://github.com/NottingHack/rules/issues>`_ for simple comments and suggestions if you don't want to get into the nitty gritty, and `pull requests <https://github.com/NottingHack/rules/pulls>`_ for more complex chnages.

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.
All members are welcome to do either, or none. Both issues and pull requests have the functionality to allow you to comment on them, so please make your feelings known.

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.
Workflow for submitting changes
-------------------------------

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.
If you can, please use a pull request for a change. This will cut down the amount of work required to integrate multiple issues.

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'.
To do this, you will need to fork (make a personal copy of) this repository into your personal account. Once you have done that, navigate to your fork and select the 'rtd-draft' branch.

You can then work on that in your browser (or your editor of choice) to make the changes you want and commit them to your fork. You can edit in browser by clicking on the file you wish to change and clicking on the edit icon (pencil) in the top right hand corner. 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.

Now you can then open a pull request to the main repository - on the front page of your fork click the green 'New pull request' button, this will show a list of changes between your copy the main repository. Click the green 'Create pull request' button, add a suitable comment and click the green 'Create pull request'.

Please keep each pull request fairly small - it should be one chanege to the rules. It is fine for it to span multiple rules, but should be all-or-nothing changes.


Workflow for making suggestions
-------------------------------

If you have a suggestion that isn't quite a change, or you can't work out how to make changes, please raise an `issue <https://github.com/NottingHack/rules/issues>`_.

Simply click 'New Issue' from that page, give it a title and a description, including as much detail as you can, and click 'Submit new issue'.

Commenting
----------

You can make comments on both `pull requests <https://github.com/NottingHack/rules/pulls>`_ and `issues <https://github.com/NottingHack/rules/issues>`_. We will leave these active for at least a few weeks, so please go in and comment on them, even if that is only to say you agree with the change.


Building rendered version locally - Advanced
Expand Down

0 comments on commit 38b772a

Please sign in to comment.