From c9af19dae11c37823173ab883ab50b1021919726 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Thu, 23 Jan 2014 10:21:06 +0100 Subject: [PATCH] rename, refine and link to new contributing doc from several places. --- CONTRIBUTING.rst | 6 ++-- doc/en/_templates/links.html | 1 + doc/en/contact.txt | 3 ++ doc/en/contents.txt | 2 +- doc/en/{contribute.txt => contributing.txt} | 0 doc/en/develop.txt | 40 --------------------- 6 files changed, 8 insertions(+), 44 deletions(-) rename doc/en/{contribute.txt => contributing.txt} (100%) delete mode 100644 doc/en/develop.txt diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3809dfc11..2ce3d18d5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,14 +15,14 @@ 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 `__ and: +`submit them as 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! +* If you have required skills and/or knowledge, we are very happy for + pull requests (see below). Report bugs ----------- diff --git a/doc/en/_templates/links.html b/doc/en/_templates/links.html index 392389703..e85c0572d 100644 --- a/doc/en/_templates/links.html +++ b/doc/en/_templates/links.html @@ -1,6 +1,7 @@

Useful Links

  • The pytest Website
    • +
  • Contribution Guide
  • pytest @ PyPI
  • pytest @ Bitbucket
  • pytest @ github
    • diff --git a/doc/en/contact.txt b/doc/en/contact.txt index 853f20a26..eb29f7073 100644 --- a/doc/en/contact.txt +++ b/doc/en/contact.txt @@ -18,6 +18,9 @@ Contact channels - `pytest-commit at python.org (mailing list)`_: for commits and new issues +- :doc:`contribution guide ` for help on submitting pull + requests to bitbucket or github. + - #pylib on irc.freenode.net IRC channel for random questions. - private mail to Holger.Krekel at gmail com if you want to communicate sensitive issues diff --git a/doc/en/contents.txt b/doc/en/contents.txt index 80d71af7d..94a772abf 100644 --- a/doc/en/contents.txt +++ b/doc/en/contents.txt @@ -16,7 +16,7 @@ Full pytest documentation plugins example/index talks - contribute + contributing funcarg_compare.txt announce/index diff --git a/doc/en/contribute.txt b/doc/en/contributing.txt similarity index 100% rename from doc/en/contribute.txt rename to doc/en/contributing.txt diff --git a/doc/en/develop.txt b/doc/en/develop.txt deleted file mode 100644 index eb32b1309..000000000 --- a/doc/en/develop.txt +++ /dev/null @@ -1,40 +0,0 @@ -================================================= -Feedback and contribute to pytest -================================================= - -.. toctree:: - :maxdepth: 2 - - contact.txt - -.. _checkout: - -Working from version control or a tarball -================================================= - -To follow development or start experiments, checkout the -complete code and documentation source with mercurial_:: - - hg clone https://bitbucket.org/hpk42/pytest/ - -You can also go to the python package index and -download and unpack a TAR file:: - - http://pypi.python.org/pypi/pytest/ - -Activating a checkout with setuptools --------------------------------------------- - -With a working Distribute_ or setuptools_ installation you can type:: - - python setup.py develop - -in order to work inline with the tools and the lib of your checkout. - -If this command complains that it could not find the required version -of "py" then you need to use the development pypi repository:: - - python setup.py develop -i http://pypi.testrun.org - - -.. include:: links.inc