5 new commits in pytest:
https://bitbucket.org/hpk42/pytest/commits/ee75804c7e18/
Changeset: ee75804c7e18
Branch: contributiondocs
User: pbanaszkiewicz
Date: 2014-01-22 11:24:58
Summary: New enthusiastic contribution guide based on Audreyr's
cookiecutter-pypackage
Audrey's code is BSD, so there should be no problem with licensing.
I've covered:
* contribution types (with hints)
* steps to start with pytest development
* testing pytest
* basics of hg
Affected #: 2 files
diff -r 7e50e96912a21240cc8dcd65a3c1fcf2e0b9cd6c -r
ee75804c7e18a8870c1b86b93099f69a70cef5bf doc/en/contents.txt
--- a/doc/en/contents.txt
+++ b/doc/en/contents.txt
@@ -16,7 +16,7 @@
plugins
example/index
talks
- develop
+ contribute
funcarg_compare.txt
announce/index
diff -r 7e50e96912a21240cc8dcd65a3c1fcf2e0b9cd6c -r
ee75804c7e18a8870c1b86b93099f69a70cef5bf doc/en/contribute.txt
--- /dev/null
+++ b/doc/en/contribute.txt
@@ -0,0 +1,122 @@
+.. _contributing:
+
+============
+Contributing
+============
+
+Contributions are highly welcomed and appreciated. Every little help counts,
+so do not hesitate!
+
+Types of contributions
+======================
+
+Submit feedback for developers
+------------------------------
+
+Do you like py.test? Share some love on Twitter or in your blog posts!
+
+We'd also like to hear about your propositions and suggestions. Feel free to
+submit them as issues `here <https://bitbucket.org/hpk42/pytest/issues>`__ and:
+
+* Set the "kind" to "enhancement" or "proposal" so that we can quickly find
+ about them.
+* 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, you can always contribute to
+ these issues!
+
+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
+--------
+
+Look through the BitBucket issues for bugs. Here is sample filter you can use:
+https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=bug
+
+:ref:'Talk <contact>' to developers to find out how you can fix specific bugs.
+
+Implement features
+------------------
+
+Look through the BitBucket issues for enhancements. Here is sample filter you
+can use:
+https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=enhancement
+
+:ref:'Talk <contact>' to developers to find out how you can implement specific
+features.
+
+Write documentation
+-------------------
+
+py.test could always use more documentation. What exactly is needed?
+
+* More complementary documentation. Have you perhaps found something unclear?
+* Documentation translations. We currently have English and Japanese versions.
+* Docstrings. There's never too much of them.
+* Blog posts, articles and such -- they're all very appreciated.
+
+Getting started for contributing
+================================
+
+1. Fork the py.test repository on BitBucket.
+.. _checkout:
+2. Clone your fork locally::
+
+ $ hg clone ssh://[email protected]/your_name_here/pytest
+
+3. Install your local copy into a virtualenv. Assuming you have
+ ``virtualenvwrapper`` (http://virtualenvwrapper.readthedocs.org) installed::
+
+ $ mkvirtualenv pytest
+ $ 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
+
+4. Create a branch for local development::
+
+ $ hg branch name-of-your-bugfix-or-feature
+
+ Now you can make your changes locally.
+
+5. When you're done making changes, check that all of them pass all the tests
+ (including PEP8 and different Python interpreter versions). It's as simple
+ as issuing this one command::
+
+ $ tox
+
+ The least minimum of required Python tests to pass is Python 2.7 and
+ Python 3.3::
+
+ $ tox -e py27,py33
+
+ If you don't seem to have ``tox`` installed, issue this from inside your
+ virtualenv::
+
+ $ pip install tox
+
+ You also need to have Python 3.3 and 2.7 available in your system.
+
+6. Commit your changes and push your branch to BitBucket::
+
+ $ hg add .
+ $ hg commit
+ $ hg push --new-branch -r .
+
+7. Submit a pull request through the BitBucket website.
+
+.. include:: links.inc
https://bitbucket.org/hpk42/pytest/commits/31b8815aa355/
Changeset: 31b8815aa355
Branch: contributiondocs
User: pbanaszkiewicz
Date: 2014-01-22 11:37:02
Summary: Moved contribution guide to the rootdir/CONTRIBUTING.txt
Affected #: 2 files
diff -r ee75804c7e18a8870c1b86b93099f69a70cef5bf -r
31b8815aa355ea06f16269758205cd3f9b8a5d00 CONTRIBUTING.txt
--- /dev/null
+++ b/CONTRIBUTING.txt
@@ -0,0 +1,119 @@
+
+============
+Contributing
+============
+
+Contributions are highly welcomed and appreciated. Every little help counts,
+so do not hesitate!
+
+Types of contributions
+======================
+
+Submit feedback for developers
+------------------------------
+
+Do you like py.test? Share some love on Twitter or in your blog posts!
+
+We'd also like to hear about your propositions and suggestions. Feel free to
+submit them as issues `here <https://bitbucket.org/hpk42/pytest/issues>`__ and:
+
+* Set the "kind" to "enhancement" or "proposal" so that we can quickly find
+ about them.
+* 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, you can always contribute to
+ these issues!
+
+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
+--------
+
+Look through the BitBucket issues for bugs. Here is sample filter you can use:
+https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=bug
+
+:ref:'Talk <contact>' to developers to find out how you can fix specific bugs.
+
+Implement features
+------------------
+
+Look through the BitBucket issues for enhancements. Here is sample filter you
+can use:
+https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=enhancement
+
+:ref:'Talk <contact>' to developers to find out how you can implement specific
+features.
+
+Write documentation
+-------------------
+
+py.test could always use more documentation. What exactly is needed?
+
+* More complementary documentation. Have you perhaps found something unclear?
+* Documentation translations. We currently have English and Japanese versions.
+* Docstrings. There's never too much of them.
+* Blog posts, articles and such -- they're all very appreciated.
+
+Getting started for contributing
+================================
+
+1. Fork the py.test repository on BitBucket.
+.. _checkout:
+2. Clone your fork locally::
+
+ $ hg clone ssh://[email protected]/your_name_here/pytest
+
+3. Install your local copy into a virtualenv. Assuming you have
+ ``virtualenvwrapper`` (http://virtualenvwrapper.readthedocs.org) installed::
+
+ $ mkvirtualenv pytest
+ $ 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
+
+4. Create a branch for local development::
+
+ $ hg branch name-of-your-bugfix-or-feature
+
+ Now you can make your changes locally.
+
+5. When you're done making changes, check that all of them pass all the tests
+ (including PEP8 and different Python interpreter versions). It's as simple
+ as issuing this one command::
+
+ $ tox
+
+ The least minimum of required Python tests to pass is Python 2.7 and
+ Python 3.3::
+
+ $ tox -e py27,py33
+
+ If you don't seem to have ``tox`` installed, issue this from inside your
+ virtualenv::
+
+ $ pip install tox
+
+ You also need to have Python 3.3 and 2.7 available in your system.
+
+6. Commit your changes and push your branch to BitBucket::
+
+ $ hg add .
+ $ hg commit
+ $ hg push --new-branch -r .
+
+7. Submit a pull request through the BitBucket website.
diff -r ee75804c7e18a8870c1b86b93099f69a70cef5bf -r
31b8815aa355ea06f16269758205cd3f9b8a5d00 doc/en/contribute.txt
--- a/doc/en/contribute.txt
+++ b/doc/en/contribute.txt
@@ -1,122 +1,3 @@
.. _contributing:
-============
-Contributing
-============
-
-Contributions are highly welcomed and appreciated. Every little help counts,
-so do not hesitate!
-
-Types of contributions
-======================
-
-Submit feedback for developers
-------------------------------
-
-Do you like py.test? Share some love on Twitter or in your blog posts!
-
-We'd also like to hear about your propositions and suggestions. Feel free to
-submit them as issues `here <https://bitbucket.org/hpk42/pytest/issues>`__ and:
-
-* Set the "kind" to "enhancement" or "proposal" so that we can quickly find
- about them.
-* 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, you can always contribute to
- these issues!
-
-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
---------
-
-Look through the BitBucket issues for bugs. Here is sample filter you can use:
-https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=bug
-
-:ref:'Talk <contact>' to developers to find out how you can fix specific bugs.
-
-Implement features
-------------------
-
-Look through the BitBucket issues for enhancements. Here is sample filter you
-can use:
-https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=enhancement
-
-:ref:'Talk <contact>' to developers to find out how you can implement specific
-features.
-
-Write documentation
--------------------
-
-py.test could always use more documentation. What exactly is needed?
-
-* More complementary documentation. Have you perhaps found something unclear?
-* Documentation translations. We currently have English and Japanese versions.
-* Docstrings. There's never too much of them.
-* Blog posts, articles and such -- they're all very appreciated.
-
-Getting started for contributing
-================================
-
-1. Fork the py.test repository on BitBucket.
-.. _checkout:
-2. Clone your fork locally::
-
- $ hg clone ssh://[email protected]/your_name_here/pytest
-
-3. Install your local copy into a virtualenv. Assuming you have
- ``virtualenvwrapper`` (http://virtualenvwrapper.readthedocs.org) installed::
-
- $ mkvirtualenv pytest
- $ 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
-
-4. Create a branch for local development::
-
- $ hg branch name-of-your-bugfix-or-feature
-
- Now you can make your changes locally.
-
-5. When you're done making changes, check that all of them pass all the tests
- (including PEP8 and different Python interpreter versions). It's as simple
- as issuing this one command::
-
- $ tox
-
- The least minimum of required Python tests to pass is Python 2.7 and
- Python 3.3::
-
- $ tox -e py27,py33
-
- If you don't seem to have ``tox`` installed, issue this from inside your
- virtualenv::
-
- $ pip install tox
-
- You also need to have Python 3.3 and 2.7 available in your system.
-
-6. Commit your changes and push your branch to BitBucket::
-
- $ hg add .
- $ hg commit
- $ hg push --new-branch -r .
-
-7. Submit a pull request through the BitBucket website.
-
-.. include:: links.inc
+.. include:: ../../CONTRIBUTING.txt
https://bitbucket.org/hpk42/pytest/commits/4458fd656dc2/
Changeset: 4458fd656dc2
Branch: contributiondocs
User: pbanaszkiewicz
Date: 2014-01-22 12:19:33
Summary: Addressed contribution guide issues: virtualenv, links, Github
mirror, RST rendering
Affected #: 1 file
diff -r 31b8815aa355ea06f16269758205cd3f9b8a5d00 -r
4458fd656dc2b6c9476fa19fa739692d927b5168 CONTRIBUTING.txt
--- a/CONTRIBUTING.txt
+++ b/CONTRIBUTING.txt
@@ -43,7 +43,7 @@
Look through the BitBucket issues for bugs. Here is sample filter you can use:
https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=bug
-:ref:'Talk <contact>' to developers to find out how you can fix specific bugs.
+:ref:`Talk <contact>` to developers to find out how you can fix specific bugs.
Implement features
------------------
@@ -52,7 +52,7 @@
can use:
https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=enhancement
-:ref:'Talk <contact>' to developers to find out how you can implement specific
+:ref:`Talk <contact>` to developers to find out how you can implement specific
features.
Write documentation
@@ -68,16 +68,29 @@
Getting started for contributing
================================
-1. Fork the py.test repository 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,
+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>`.
+
+1. Fork the py.test `repository <https://bitbucket.org/hpk42/pytest>`__ on
BitBucket.
+
+2. Create a local virtualenv (http://www.virtualenv.org/en/latest/)::
+
+ $ virtualenv pytest-venv
+ $ cd pytest-venv/
+
.. _checkout:
-2. Clone your fork locally::
+
+3. Clone your fork locally::
$ hg clone ssh://[email protected]/your_name_here/pytest
-3. Install your local copy into a virtualenv. Assuming you have
- ``virtualenvwrapper`` (http://virtualenvwrapper.readthedocs.org) installed::
+.. _installing-dev-pytest:
- $ mkvirtualenv pytest
+4. Install your local copy into a virtualenv::
+
$ cd pytest/
$ python setup.py develop
@@ -86,11 +99,7 @@
$ python setup.py develop -i http://pypi.testrun.org
-4. Create a branch for local development::
-
- $ hg branch name-of-your-bugfix-or-feature
-
- Now you can make your changes locally.
+.. _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). It's as simple
@@ -110,10 +119,41 @@
You also need to have Python 3.3 and 2.7 available in your system.
-6. Commit your changes and push your branch to BitBucket::
+6. Commit your changes and push to BitBucket::
$ hg add .
$ hg commit
- $ hg push --new-branch -r .
+ $ hg push -r .
7. Submit a pull request through the BitBucket website.
+
+
+.. _contribution-on-github:
+What about 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.
+
+2. Create a local virtualenv (http://www.virtualenv.org/en/latest/)::
+
+ $ virtualenv pytest-venv
+ $ cd pytest-venv/
+
+3. Clone your fork locally::
+
+ $ git clone [email protected]: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>`.
+
+5. Commit your changes and push to GitHub::
+
+ $ git add .
+ $ git commit
+ $ git push -u
+
+6. Submit a pull request through the GitHub website.
https://bitbucket.org/hpk42/pytest/commits/8fefd50ec004/
Changeset: 8fefd50ec004
Branch: contributiondocs
User: pbanaszkiewicz
Date: 2014-01-22 17:05:11
Summary: Contribution guide: moved tox inst. instructions up
Affected #: 1 file
diff -r 4458fd656dc2b6c9476fa19fa739692d927b5168 -r
8fefd50ec0044a336f235a63369bf802723895bd CONTRIBUTING.txt
--- a/CONTRIBUTING.txt
+++ b/CONTRIBUTING.txt
@@ -102,22 +102,20 @@
.. _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). It's as simple
- as issuing this one command::
+ (including PEP8 and different Python interpreter versions). First install
+ ``tox``::
- $ tox
+ $ pip install tox
- The least minimum of required Python tests to pass is Python 2.7 and
- Python 3.3::
+ 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::
$ tox -e py27,py33
- If you don't seem to have ``tox`` installed, issue this from inside your
- virtualenv::
+ 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::
- $ pip install tox
-
- You also need to have Python 3.3 and 2.7 available in your system.
+ $ tox
6. Commit your changes and push to BitBucket::
https://bitbucket.org/hpk42/pytest/commits/506a2abc6144/
Changeset: 506a2abc6144
User: bubenkoff
Date: 2014-01-23 00:52:49
Summary: merge pbanaszkiewicz/contributiondocs
Affected #: 3 files
diff -r 634ccdf8a2747cc3f662f4bacf1d25047c62a7bc -r
506a2abc6144bef2cfb8be6b6210acf1c964a9b0 CONTRIBUTING.rst
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,161 @@
+
+============
+Contributing
+============
+
+Contributions are highly welcomed and appreciated. Every little help counts,
+so do not hesitate!
+
+Types of contributions
+======================
+
+Submit feedback for developers
+------------------------------
+
+Do you like py.test? Share some love on Twitter or in your blog posts!
+
+We'd also like to hear about your propositions and suggestions. Feel free to
+submit them as issues `here <https://bitbucket.org/hpk42/pytest/issues>`__ and:
+
+* Set the "kind" to "enhancement" or "proposal" so that we can quickly find
+ about them.
+* 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, you can always contribute to
+ these issues!
+
+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
+--------
+
+Look through the BitBucket issues for bugs. Here is sample filter you can use:
+https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=bug
+
+:ref:`Talk <contact>` to developers to find out how you can fix specific bugs.
+
+Implement features
+------------------
+
+Look through the BitBucket issues for enhancements. Here is sample filter you
+can use:
+https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=enhancement
+
+:ref:`Talk <contact>` to developers to find out how you can implement specific
+features.
+
+Write documentation
+-------------------
+
+py.test could always use more documentation. What exactly is needed?
+
+* More complementary documentation. Have you perhaps found something unclear?
+* Documentation translations. We currently have English and Japanese versions.
+* Docstrings. There's never too much of them.
+* Blog posts, articles and such -- they're all very appreciated.
+
+Getting started for contributing
+================================
+
+The primary development platform for py.test 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>`.
+
+1. Fork the py.test `repository <https://bitbucket.org/hpk42/pytest>`__ on
BitBucket.
+
+2. Create a local virtualenv (http://www.virtualenv.org/en/latest/)::
+
+ $ virtualenv pytest-venv
+ $ cd pytest-venv/
+ $ source bin/activate
+
+.. _checkout:
+
+3. Clone your fork locally::
+
+ $ hg clone ssh://[email protected]/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
+
+.. _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``::
+
+ $ 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::
+
+ $ tox -e py27,py33
+
+ 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::
+
+ $ tox
+
+6. Commit your changes and push to BitBucket::
+
+ $ hg branch <yourbranchname>
+ $ hg add .
+ $ hg commit -m"<commit message>
+ $ hg push -b .
+
+7. Submit a pull request through the BitBucket website.
+
+
+.. _contribution-on-github:
+What about 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.
+
+2. Create a local virtualenv (http://www.virtualenv.org/en/latest/)::
+
+ $ virtualenv pytest-venv
+ $ cd pytest-venv/
+
+3. Clone your fork locally::
+
+ $ git clone [email protected]: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>`.
+
+5. Commit your changes and push to GitHub::
+
+ $ git branch <yourbranchname>
+ $ git checkout <yourbranchname>
+ $ git add .
+ $ git commit -am"<commit message>"
+ $ git push origin <yourbranchname>
+
+6. Submit a pull request through the GitHub website.
diff -r 634ccdf8a2747cc3f662f4bacf1d25047c62a7bc -r
506a2abc6144bef2cfb8be6b6210acf1c964a9b0 doc/en/contents.txt
--- a/doc/en/contents.txt
+++ b/doc/en/contents.txt
@@ -16,7 +16,7 @@
plugins
example/index
talks
- develop
+ contribute
funcarg_compare.txt
announce/index
diff -r 634ccdf8a2747cc3f662f4bacf1d25047c62a7bc -r
506a2abc6144bef2cfb8be6b6210acf1c964a9b0 doc/en/contribute.txt
--- /dev/null
+++ b/doc/en/contribute.txt
@@ -0,0 +1,3 @@
+.. _contributing:
+
+.. include:: ../../CONTRIBUTING.rst
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
[email protected]
https://mail.python.org/mailman/listinfo/pytest-commit
