diff options
| -rw-r--r-- | docs/development/contributing.rst | 16 | ||||
| -rw-r--r-- | docs/installing.rst | 12 |
2 files changed, 16 insertions, 12 deletions
diff --git a/docs/development/contributing.rst b/docs/development/contributing.rst index c509b6b22..821323755 100644 --- a/docs/development/contributing.rst +++ b/docs/development/contributing.rst @@ -11,8 +11,14 @@ Submitting Pull Requests ======================== Submit pull requests against the ``master`` branch, providing a good -description of what you're doing and why. Provide tests that cover your changes -and run the tests locally first. +description of what you're doing and why. You must have legal permission to +distribute any code you contribute to pip and it must be available under the +MIT License. + +Provide tests that cover your changes and run the tests locally first. pip +:ref:`supports <compatibility-requirements>` multiple Python versions and +operating systems. Any pull request must consider and work on all these +platforms. Pull Requests should be small to facilitate easier review. Keep them self-contained, and limited in scope. `Studies have shown`_ that review quality @@ -22,16 +28,12 @@ as "feature branches", with ongoing development work happening within the PR. Instead, the feature should be broken up into smaller, independent parts which can be reviewed and merged individually. -When creating a pull request, avoid including "cosmetic" changes to code that +Additionally, avoid including "cosmetic" changes to code that is unrelated to your change, as these make reviewing the PR more difficult. Examples include re-flowing text in comments or documentation, or addition or removal of blank lines or whitespace within lines. Such changes can be made separately, as a "formatting cleanup" PR, if needed. -You must have legal permission to distribute any code you contribute to -pip and it must be available under the MIT License. - - Automated Testing ================= diff --git a/docs/installing.rst b/docs/installing.rst index 916c3a3ba..2daa2c108 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -6,10 +6,10 @@ Installation Do I need to install pip? ------------------------- -pip is already installed if you are using Python 2 >=2.7.9 or Python 3 >=3.4 -downloaded from `python.org <https://www.python.org>`_ or if you are working -in a :ref:`Virtual Environment <pypug:Creating and using Virtual Environments>` -created by :ref:`pypug:virtualenv` or :ref:`pyvenv <pypug:venv>`. +pip is already installed if you are using Python 2 >=2.7.9 or Python 3 >=3.4 +downloaded from `python.org <https://www.python.org>`_ or if you are working +in a :ref:`Virtual Environment <pypug:Creating and using Virtual Environments>` +created by :ref:`pypug:virtualenv` or :ref:`pyvenv <pypug:venv>`. Just make sure to :ref:`upgrade pip <Upgrading pip>`. @@ -34,7 +34,7 @@ Inspect ``get-pip.py`` for any malevolence. Then run the following:: system or another package manager. ``get-pip.py`` does not coordinate with those tools, and may leave your system in an inconsistent state. -``get-pip.py`` also installs :ref:`pypug:setuptools` [2]_ and :ref:`pypug:wheel` +``get-pip.py`` also installs :ref:`pypug:setuptools` [2]_ and :ref:`pypug:wheel` if they are not already. :ref:`pypug:setuptools` is required to install :term:`source distributions <pypug:Source Distribution (or "sdist")>`. Both are required in order to build a :ref:`Wheel cache` (which improves installation @@ -104,6 +104,8 @@ On Windows [4]_:: python -m pip install -U pip +.. _compatibility-requirements: + Python and OS Compatibility --------------------------- |