Contributing Docs

CONTRIBUTING.rst

@@ -1,131 +1,8 @@
-.. highlight:: shell
-
 ============
 Contributing
 ============
 
-Contributions are welcome, and they are greatly appreciated! Every little bit
-helps, and credit will always be given.
-
-You can contribute in many ways:
-
-Types of Contributions
-----------------------
-
-Report Bugs
-~~~~~~~~~~~
-
-Report bugs at https://github.com/gtalarico/pipenv-pipes/issues.
-
-
-Fix Bugs
-~~~~~~~~
-
-Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
-wanted" is open to whoever wants to implement it.
-
-Implement Features
-~~~~~~~~~~~~~~~~~~
-
-Look through the GitHub issues for features. Anything tagged with "enhancement"
-and "help wanted" is open to whoever wants to implement it.
-
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
-
-Pipenv Pipes could always use more documentation, whether as part of the
-official Pipenv Pipes docs, in docstrings, or even on the web in blog posts,
-articles, and such.
-
-Submit Feedback
-~~~~~~~~~~~~~~~
-
-The best way to send feedback is to file an issue at https://github.com/gtalarico/pipenv-pipes/issues.
-
-If you are proposing a feature:
-
-* Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that contributions
-  are welcome :)
-
-Setup Pipes Development Environment
------------------------------------
-
-Ready to contribute? Here's how to set up `pipenv_pipes` for local development.
-
-1. Fork the `pipenv_pipes` repo on GitHub.
-2. Clone your fork locally::
-
-    $ git clone git@github.com:your_name_here/pipenv_pipes.git
-
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
-
-    $ cd pipenv_pipes
-    $ pipenv install --dev
-    $ python setup.py develop
-
-4. Create a branch for local development::
-
-    $ git checkout -b name-of-your-bugfix-or-feature
-
-   Now you can make your changes locally.
-
-5. When you're done making changes, check that your changes pass all tests (see below).
-
-6. Commit your changes and push your branch to GitHub::
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
-
-7. Submit a pull request through the GitHub website.
-
-Testing
--------
-
-To run the test suite:
-
-$ flake8 pipenv_pipes tests
-$ python setup.py test or pytest
-$ tox
-
-To get flake8 and tox, just install them into your virtualenv.
-
-$ pipenv install --dev
-
-To run a subset of tests::
-
-$ pytest -k test_name
-
-
-Pull Request Guidelines
------------------------
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
-   https://travis-ci.org/gtalarico/pipenv_pipes/pull_requests
-   and make sure that the tests pass for all supported Python versions.
-
-
-Deploying
----------
-
-A reminder for the maintainers on how to deploy.
-Make sure all your changes are committed (including an entry in HISTORY.rst).
-Then run::
-
-$ bump2version patch # possible: major / minor / patch
-$ git push
-$ git push --tags
-
-Travis will then deploy to PyPI if tests pass.
-
-
-
-* ``pip install -e . `` failes on windows due to curses requirement
-    Use ``$ python setup.py develop`` instead.
+Contributions are welcome and greatly appreciated!
+For more information on how to contribute to this project
+checkout the documentation on
+`pipenv-pipes.readthedocs.io <pipenv-pipes.readthedocs.io/en/latest/contributing.html>`_

docs/contributing.rst

@@ -1 +1,160 @@
-.. include:: ../CONTRIBUTING.rst
+.. highlight:: console
+
+============
+Contributing
+============
+
+Contributions are welcome and greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+-----------------------------------------------------------------------
+
+How to Contribute
+-----------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/gtalarico/pipenv-pipes/issues.
+
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Pipenv Pipes could always use more documentation, whether as part of the
+official Pipenv Pipes docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/gtalarico/pipenv-pipes/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome.
+
+------------------------------------------------------------
+
+Setup Pipes Development Environment
+-----------------------------------
+
+Ready to contribute?
+Here's how to set up Pipes for local development.
+
+1. Fork the the Pipes repository from `GitHub`_.
+
+.. _Github: https://github.com/gtalarico/pipenv-pipes#fork-destination-box
+
+
+2. Clone your fork locally:
+
+.. code:: console
+
+    $ git clone git@github.com:YOUR_GITHUB_USERNAME/pipenv_pipes.git
+
+
+3. Create a virtualenvironment - we will use Pipenv:
+
+.. code:: console
+
+    $ cd pipenv_pipes
+    $ pipenv install --dev
+    $ python setup.py develop
+
+4. Create a branch for local development so you can make your changes locally:
+
+.. code:: console
+
+  $ git checkout -b name-of-your-bugfix-or-feature
+
+
+5. When you're done making changes, check that your changes pass all tests. See the `Testing`_ section below for more details on testing.
+
+6. Commit your changes and push your branch to GitHub::
+
+.. code:: console
+
+  $ git add .
+  $ git commit -m "Your detailed description of your changes."
+  $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+
+-----------------------------------------
+
+Testing
+-------
+
+Run test suite
+~~~~~~~~~~~~~~
+
+Tests use Pytest. To run the test suite run:
+
+.. code:: console
+
+  $ pytest
+  or
+  $ python setup.py test or
+
+Linter
+~~~~~~
+
+Make sure the code follows Flake 8 standard by using a linter within your code
+editor or use the command below:
+
+.. code:: console
+
+  $ flake8 pipenv_pipes tests
+
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
+   https://travis-ci.org/gtalarico/pipenv_pipes/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run:
+
+.. code:: console
+
+  $ bump2version  major / minor / patch / release
+  $ git push
+  $ git push --tags
+
+.. note::
+
+  Travis should run all tests but integration with PyPI is currently disabled.
+  To deploy to Pypi use ``make release``.

docs/usage.rst

@@ -1,4 +1,4 @@
-.. highlight:: shell
+.. highlight:: console
 
 =====
 Usage
@@ -144,10 +144,7 @@ directory.
   and the feature will be removed.
 
 
-  .. _`Pull Request`
-
-
-
+  .. _`Pull Request`: https://github.com/pypa/pipenv/pull/1861
 
 --------------------------------------------------------
 
@@ -157,10 +154,13 @@ Unlink a Project
 
 To unlink ``project1`` directory from its Pipenv Environment run:
 
-.. code:: bash
+.. code:: console
 
     $ pipes --unlink project1
 
+This will delete the ``.project`` file created
+by the `Set Project Directory`_ command.
+
 
 ----------------------------------------------------------
 
@@ -171,6 +171,6 @@ Usage Help
 You can see the list of available commands directly from
 the command line:
 
-.. code::
+.. code:: console
 
     $ pipes --help