Skip to content

Commit

Permalink
Including the CONTRIBUTING doc
Browse files Browse the repository at this point in the history
  • Loading branch information
danielquinn committed Nov 2, 2015
1 parent dc86f59 commit ad714e8
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 22 deletions.
26 changes: 16 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,35 @@ we adhere to the `Code of Conduct`_ by the Python Software Foundation.

The following steps will help you get started:

Fork, then clone the repo:::
Fork, then clone the repo:

git clone [email protected]:your-username/ripe-atlas-tools.git
.. code:: bash
Make sure the tests pass beforehand:::
$ git clone [email protected]:your-username/ripe-atlas-tools.git
tox
Make sure the tests pass beforehand:

.. code:: bash
$ tox
or

::
.. code:: bash
$ nosetests tests/
nosetests tests/
Make your changes. Include tests for your change. Make the tests pass:

Make your changes. Include tests for your change. Make the tests pass:::
.. code:: bash
tox
$ tox
or

::
.. code:: bash
nosetests tests/
$ nosetests tests/
Push to your fork and `submit a pull request`_.

Expand Down
1 change: 1 addition & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../CONTRIBUTING.rst
23 changes: 11 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
.. RIPE Atlas Tools (Magellan) documentation master file, created by
sphinx-quickstart on Mon Oct 26 18:36:52 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
RIPE Atlas Tools (Magellan)
===========================

The official command-line client for RIPE Atlas.

.. _index-why-this-exists:


Why This Exists
===============

[RIPE Atlas](https://atlas.ripe.net) is a powerful Internet measurements platform
that until recently was only accessible via the website and the RESTful API.
The reality however is that a great many people using RIPE Atlas are most comfortable
on the command-line, so this project is an attempt to fill that gap.
[RIPE Atlas](https://atlas.ripe.net) is a powerful Internet measurements
platform that until recently was only accessible via the website and the RESTful
API. The reality however is that a great many people using RIPE Atlas are most
comfortable on the command-line, so this project is an attempt to fill that gap.


Contents:
Contents
========

.. toctree::
:maxdepth: 3
:maxdepth: 2

installation
quickstart
installation
use
contributing
troubleshooting

0 comments on commit ad714e8

Please sign in to comment.