1 new commit in pytest: https://bitbucket.org/hpk42/pytest/commits/6cfd2a33354d/ Changeset: 6cfd2a33354d User: hpk42 Date: 2014-01-23 11:38:05 Summary: refine contributing text in several places Affected #: 2 files
diff -r 0b1fb07d0f8fbe68e5dfe60a07ccdc689241e098 -r 6cfd2a33354d06d2481a3860a1a41d13b0d35ca2 CONTRIBUTING.rst --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,6 +9,19 @@ Types of contributions ====================== +Report bugs +----------- + +Report bugs at https://bitbucket.org/hpk42/pytest/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting, + specifically Python interpreter version, + installed libraries and py.test version. +* Detailed steps to reproduce the bug. + Submit feedback for developers ------------------------------ @@ -24,18 +37,6 @@ * If you have required skills and/or knowledge, we are very happy for pull requests (see below). -Report bugs ------------ - -Report bugs at https://bitbucket.org/hpk42/pytest/issues. - -If you are reporting a bug, please include: - -* Your operating system name and version. -* Any details about your local setup that might be helpful in troubleshooting, - specifically Python interpreter version, - installed libraries and py.test version. -* Detailed steps to reproduce the bug. Fix bugs -------- @@ -65,8 +66,8 @@ * Docstrings. There's never too much of them. * Blog posts, articles and such -- they're all very appreciated. -Getting started for contributing -================================ +Preparing Pull Requests on Bitbucket +===================================== The primary development platform for py.test is BitBucket. You can find all the issues there and submit pull requests. There is, however, @@ -74,58 +75,59 @@ although it only allows for submitting pull requests. For a GitHub contribution guide look :ref:`below <contribution-on-github>`. -1. Fork the py.test `repository <https://bitbucket.org/hpk42/pytest>`__ on BitBucket. +1. Fork the `pytest bitbucket repository <https://bitbucket.org/hpk42/pytest>`__. It's fine to + use ``pytest`` as your fork repository name because it will live + under your user. -2. Create a local virtualenv (http://www.virtualenv.org/en/latest/):: +.. _virtualenvactivate: + +2. Create and activate a fork-specific virtualenv + (http://www.virtualenv.org/en/latest/):: $ virtualenv pytest-venv - $ cd pytest-venv/ - $ source bin/activate + $ source pytest-venv/bin/activate .. _checkout: -3. Clone your fork locally:: +3. Clone your fork locally and create a branch:: - $ hg clone ssh://h...@bitbucket.org/your_name_here/pytest - -.. _installing-dev-pytest: - -4. Install your local copy into a virtualenv:: - - $ cd pytest/ - $ python setup.py develop - - If that last command complains about not finding the required version - of "py" then you need to use the development pypi repository:: - - $ python setup.py develop -i http://pypi.testrun.org + $ hg clone ssh://h...@bitbucket.org/YOUR_BITBUCKET_USERNAME/pytest + $ cd pytest + $ hg branch <yourbranchname> .. _testing-pytest: -5. When you're done making changes, check that all of them pass all the tests - (including PEP8 and different Python interpreter versions). First install - ``tox``:: +4. You can now edit your local working copy. To test you need to + install the "tox" tool into your virtualenv:: $ pip install tox - You also need to have Python 2.7 and 3.3 available in your system. Now - running tests is as simple as issuing this one command:: + You need to have Python 2.7 and 3.3 available in your system. Now + running tests is as simple as issuing this command:: - $ tox -e py27,py33 + $ python runtox.py -e py27,py33,flakes - This command will run tests for both Python 2.7 and 3.3, which is a minimum - required to get your patch merged. To run whole test suit issue:: + This command will run tests via the "tox" tool against Python 2.7 and 3.3 + and also perform "flakes" coding-style checks. ``runtox.py`` is + a thin wrapper around ``tox`` which installs from a development package + index where newer (not yet released to pypi) versions of dependencies + (especially ``py``) might be present. - $ tox + To run tests on py27 and pass options (e.g. enter pdb on failure) + to pytest you can do:: -6. Commit your changes and push to BitBucket:: + $ python runtox.py -e py27 -- --pdb - $ hg branch <yourbranchname> - $ hg add . - $ hg commit -m"<commit message> + or to only run tests in a particular test module on py33:: + + $ python runtox.py -e py33 -- testing/test_config.py + +5. Commit and push once your tests pass and you are happy with your change(s):: + + $ hg commit -m"<commit message>" $ hg push -b . -7. Submit a pull request through the BitBucket website: +6. Finally, submit a pull request through the BitBucket website:: source: <your user>/pytest branch: <yourbranchname> @@ -133,34 +135,32 @@ target: hpk42/pytest branch: default +.. _contribution-on-github: -.. _contribution-on-github: -What about GitHub? ------------------- +Preparing Pull Requests on Github +===================================== .. warning:: + Remember that GitHub is **not** a default development platform for py.test and it doesn't include e.g. issue list. -1. Fork the py.test `repository <https://github.com/hpk42/pytest/>`__ on GitHub. +1. Fork the `pytest github repository <https://github.com/hpk42/pytest/>`__. -2. Create a local virtualenv (http://www.virtualenv.org/en/latest/):: +2. :ref:`create and activate virtualenv <virtualenvactivate>`. - $ virtualenv pytest-venv - $ cd pytest-venv/ +3. Clone your github fork locally and create a branch:: -3. Clone your fork locally:: + $ git clone g...@github.com:YOUR_GITHUB_USERNAME/pytest.git + $ cd pytest + $ git branch <yourbranchname> + $ git checkout <yourbranchname> - $ git clone g...@github.com:your_name_here/pytest.git - -4. :ref:`Install your local copy into a virtualenv <installing-dev-pytest>` - and after that :ref:`test your changes <testing-pytest>`. +4. :ref:`test your changes <testing-pytest>`. 5. Commit your changes and push to GitHub:: - $ git branch <yourbranchname> - $ git checkout <yourbranchname> - $ git add . + $ git add PATH/TO/MODIFIED/FILE # to add changes to staging $ git commit -am"<commit message>" $ git push origin <yourbranchname> diff -r 0b1fb07d0f8fbe68e5dfe60a07ccdc689241e098 -r 6cfd2a33354d06d2481a3860a1a41d13b0d35ca2 runtox.py --- /dev/null +++ b/runtox.py @@ -0,0 +1,10 @@ +#!/usr/bin/env python + +import subprocess +import sys + +if __name__ == "__main__": + subprocess.call(["tox", + "-i", "ALL=https://devpi.net/hpk/dev/";, + "--develop",] + sys.argv[1:]) + Repository URL: https://bitbucket.org/hpk42/pytest/ -- This is a commit notification from bitbucket.org. You are receiving this because you have the service enabled, addressing the recipient of this email. _______________________________________________ pytest-commit mailing list pytest-commit@python.org https://mail.python.org/mailman/listinfo/pytest-commit
