3 new commits in pytest: https://bitbucket.org/hpk42/pytest/commits/a4999cc9837a/ Changeset: a4999cc9837a User: pbanaszkiewicz Date: 2014-01-24 19:21:21 Summary: Contribution guide: added "what is pull request" section Affected #: 1 file
diff -r 8c0e79d2c8cab40e85e94d4193c0cafcba1b78d2 -r a4999cc9837abdda131ccdb5f3a8396031fa9c6b CONTRIBUTING.rst --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -35,7 +35,7 @@ * Explain in detail how they should work. * Keep the scope as narrow as possible. This will make it easier to implement. * If you have required skills and/or knowledge, we are very happy for - pull requests (see below). + :ref:`pull requests <pull-requests>`. Fix bugs @@ -66,14 +66,23 @@ * Docstrings. There's never too much of them. * Blog posts, articles and such -- they're all very appreciated. +.. _pull-requests: + Preparing Pull Requests on Bitbucket ===================================== +.. note:: + What is a "pull request"? It informs project's core developers about the + changes you want to review and merge. Pull requests are stored on + `BitBucket servers <https://bitbucket.org/hpk42/pytest/pull-requests>`__. + Once you send pull request, we can discuss it's potential modifications and + even add more commits to it later on. + The primary development platform for pytest is BitBucket. You can find all the issues there and submit pull requests. There is, however, a `GitHub mirror <https://github.com/hpk42/pytest/>`__ available, too, although it only allows for submitting pull requests. For a GitHub -contribution guide look :ref:`below <contribution-on-github>`. +contribution guide look :ref:`below <contribution-using-git>`. 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 https://bitbucket.org/hpk42/pytest/commits/9859b18ee4f0/ Changeset: 9859b18ee4f0 User: pbanaszkiewicz Date: 2014-01-24 19:37:44 Summary: Contribution guide: removed confusion regarding git Affected #: 1 file diff -r a4999cc9837abdda131ccdb5f3a8396031fa9c6b -r 9859b18ee4f095507af27eaf5accdb65b1694fdd CONTRIBUTING.rst --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -79,14 +79,12 @@ even add more commits to it later on. The primary development platform for pytest is BitBucket. You can find all -the issues there and submit pull requests. There is, however, -a `GitHub mirror <https://github.com/hpk42/pytest/>`__ available, too, -although it only allows for submitting pull requests. For a GitHub -contribution guide look :ref:`below <contribution-using-git>`. +the issues there and submit your pull requests. -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. +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. .. _virtualenvactivate: @@ -98,11 +96,15 @@ .. _checkout: -3. Clone your fork locally and create a branch:: +3. Clone your fork locally using `Mercurial <http://mercurial.selenic.com/>`_ + (``hg``) and create a branch:: $ hg clone ssh://h...@bitbucket.org/YOUR_BITBUCKET_USERNAME/pytest $ cd pytest - $ hg branch <yourbranchname> + $ hg branch your-branch-name + + If you need some help with Mercurial, follow this quick start + guide: http://mercurial.selenic.com/wiki/QuickStart .. _testing-pytest: @@ -138,8 +140,8 @@ 6. Finally, submit a pull request through the BitBucket website:: - source: <your user>/pytest - branch: <yourbranchname> + source: YOUR_BITBUCKET_USERNAME/pytest + branch: your-branch-name target: hpk42/pytest branch: default @@ -149,14 +151,18 @@ What about git (and so GitHub)? ------------------------------- -There used to be the pytest github mirror. It was removed in favor of this mercurial one, to remove confusion of people -not knowing where it's better to put their issues and pull requests. Also it wasn't easilily possible to automate -mirroring process. -However, it's still possible to use git to contribute to pytest using tools like https://github.com/buchuki/gitifyhg -which allow you to clone and work mercurial repo still using git. +There used to be the pytest GitHub mirror. It was removed in favor of the +Mercurial one, to remove confusion of people not knowing where it's better to +put their issues and pull requests. Also it wasn't easily possible to automate +the mirroring process. + +However, it's still possible to use git to contribute to pytest using tools +like `gitifyhg <https://github.com/buchuki/gitifyhg>`_ which allows you to +clone and work with Mercurial repo still using git. .. warning:: - Remember that git is **not** a default version control system py.test and you need to be careful using git - to work with it. + Remember that git is **not** a default version control system for pytest and + you need to be careful using it. -Please read the manual carefully, and then use same contribution manual as for BitBucket. +Please read the manual carefully, and then use same contribution manual as for +BitBucket. https://bitbucket.org/hpk42/pytest/commits/f428ddd78673/ Changeset: f428ddd78673 User: pbanaszkiewicz Date: 2014-01-24 20:01:04 Summary: Contribution guide: added pull request button image Affected #: 2 files diff -r 9859b18ee4f095507af27eaf5accdb65b1694fdd -r f428ddd78673080a63c59887cb4f603d29d6ed4a CONTRIBUTING.rst --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -138,7 +138,13 @@ $ hg commit -m"<commit message>" $ hg push -b . -6. Finally, submit a pull request through the BitBucket website:: +6. Finally, submit a pull request through the BitBucket website: + + .. image:: img/pullrequest.png + :width: 700px + :align: center + + :: source: YOUR_BITBUCKET_USERNAME/pytest branch: your-branch-name @@ -146,8 +152,8 @@ target: hpk42/pytest branch: default +.. _contribution-using-git: -.. _contribution-using-git: What about git (and so GitHub)? ------------------------------- @@ -163,6 +169,3 @@ .. warning:: Remember that git is **not** a default version control system for pytest and you need to be careful using it. - -Please read the manual carefully, and then use same contribution manual as for -BitBucket. diff -r 9859b18ee4f095507af27eaf5accdb65b1694fdd -r f428ddd78673080a63c59887cb4f603d29d6ed4a doc/en/img/pullrequest.png Binary file doc/en/img/pullrequest.png has changed 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
