Skip to content

Commit

Permalink
add Testing section
Browse files Browse the repository at this point in the history
  • Loading branch information
herlo committed Sep 21, 2017
1 parent b4f4c0a commit c0ca3bf
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,6 @@ In this way, each feature can track its changes and not conflict with others.
.. note:: the ``-u`` option. This is a nicety of git, allowing future pushes
to assume the remote ``origin`` and the branch ``contributing_docs``.

Once the feature branch is created, development work continues as normal.
After some code has been created, edited, or removed, please commit this work.

.. code-block:: bash
$ git add CONTRIBUTING.rst
Expand All @@ -90,6 +87,21 @@ Follow the guidance in the article by Chris Beams
.. note:: It is considered useful to commit often. Usually small bits of work
are easier to revert than large swaths of code across multiple files.

Testing
+++++++

Please test all commits before pushing.

1. make sure you have all the extras_require packages installed, as listed in `setup.py <https://github.com/CentOS-PaaS-SIG/linchpin/blob/develop/setup.py>`_

* Specifically, one could perform `pip install linchpin[tests]` to install the requirements

2. From the repository-root, follow the `install` and `script` sections of `.travis.yaml <https://github.com/CentOS-PaaS-SIG/linchpin/blob/develop/.travis.yml>`_
3 The tests will have passed if all script commands exit 0

Once the feature branch is created, development work continues as normal.
After some code has been created, edited, or removed, please commit this work.


Submit a Pull Request
+++++++++++++++++++++
Expand Down

0 comments on commit c0ca3bf

Please sign in to comment.