summaryrefslogtreecommitdiff
path: root/doc/contribute.rst
diff options
context:
space:
mode:
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>2013-04-29 15:31:03 +0200
committerNicolas Chauvat <nicolas.chauvat@logilab.fr>2013-04-29 15:31:03 +0200
commiteaf43c6b172f26b4e5b5fb0d65ec070b0abe71c8 (patch)
tree0288bbb8c8d51a2f92de0b4df73fe6ed8750db17 /doc/contribute.rst
parente0d31c2ec17a9968ced556e7e12b37468db1c190 (diff)
downloadpylint-eaf43c6b172f26b4e5b5fb0d65ec070b0abe71c8.tar.gz
[doc] continue refactoring
Diffstat (limited to 'doc/contribute.rst')
-rw-r--r--doc/contribute.rst79
1 files changed, 31 insertions, 48 deletions
diff --git a/doc/contribute.rst b/doc/contribute.rst
index 20dd8e4..346ec15 100644
--- a/doc/contribute.rst
+++ b/doc/contribute.rst
@@ -8,88 +8,71 @@ Bug reports, feedback
---------------------
You think you have found a bug in Pylint? Well, this may be the case
-since Pylint is under development. Please take the time to send a bug
-report to python-projects@logilab.org if you've not found it already reported on
-the `tracker page`_. This mailing list is also a nice place to
-discuss Pylint issues, see below for more information about Pylint's related
-lists.
+since Pylint is under development.
-You can check for already reported bugs, planned features on Pylint's tracker
-web page: https://bitbucket.org/logilab/pylint/issues
+Please take the time to check if it is already in the issue tracker at
+https://bitbucket.org/logilab/pylint
-Notice that if you don't find something you have expected in Pylint's
-tracker page, it may be on the tracker page of one of its dependencies, namely
+If you can not find it in the tracker, create a new issue there or discuss your
+problem on the code-quality@python.org mailing list.
+
+The code-quality mailing list is also a nice place to provide feedback about
+Pylint, since it is shared with other tools that aim at improving the quality of
+python code.
+
+Note that if you don't find something you have expected in Pylint's
+issue tracker, it may be because it is an issue with one of its dependencies, namely
astng and common:
-* https://bitbucket.org/logilab/astng/issues
+* https://bitbucket.org/logilab/astng
* http://www.logilab.org/project/logilab-common
-.. _`tracker page`: https://bitbucket.org/logilab/pylint/issues
-
Mailing lists
-------------
-Use the python-projects@logilab.org mailing list for anything related
+Use the code-quality@python.org mailing list for anything related
to Pylint. This is in most cases better than sending an email directly
to the author, since others will benefit from the exchange, and you'll
-be more likely answered by someone subscribed to the list. This is a
-moderated mailing list, so if you're not subscribed email you send will have to
-be validated first before actually being sent on the list.
+be more likely answered by someone subscribed to the list.
You can subscribe to this mailing list at
-http://lists.logilab.org/mailman/listinfo/python-projects
+http://lists.python.org/mailman/listinfo/code-quality
Archives are available at
-http://lists.logilab.org/pipermail/python-projects/
-
-If you prefer speaking French instead of English, you can use the
-generic forum-fr@logilab.org mailing list:
+http://lists.python.org/pipermail/code-quality/
-* (un)subscribe: http://lists.logilab.org/mailman/listinfo/forum-fr
-* archives: http://lists.logilab.org/pipermail/forum-fr
-
-Notice though that this list has a very low traffic since most Pylint related
-discussions are done on the python-projects mailing list.
+Archives before April 2013 are available at
+http://lists.logilab.org/pipermail/python-projects/
-Development
------------
+Forge
+-----
-Pylint is developped using the mercurial_ version control system. This is a very
-cool distributed VCS and its usage is very similar to other ones such as cvs or
-subversion (though the distributed feature introduced some different usage
-patterns). See mercurial_ home page for installation on your computer and basic
-usage. Note that it's very easy to send us patches using `hg email` command ;).
+Pylint is developped using the mercurial_ distributed version control system.
-You can get the in-development Pylint source code from its bitbucket repository: ::
+You can clone Pylint and its dependencies from ::
hg clone https://bitbucket.org/logilab/pylint
-
-The same is true for Pylint dependencies (if you use Pylint code from the
-repository, you should usually use code from the repository as well for astng
-and logilab-common): ::
-
hg clone https://bitbucket.org/logilab/astng
hg clone http://hg.logilab.org/logilab/common
.. _mercurial: http://www.selenic.com/mercurial/
-Got a patch for Pylint? There a few steps you must take to make sure your
+Got a change for Pylint? There a few steps you must take to make sure your
patch gets accepted.
-* Test your code
+- Test your code
- * Pylint keeps a set of unit tests in the /test directory. To get your
+ - Pylint keeps a set of unit tests in the /test directory. To get your
patch accepted you must write (or change) a test input file and message
file in the appropriate input and messages folders.
- * In the test folder of pylint run ./fulltest.sh (python version), make sure
+ - In the test folder of Pylint run ``./fulltest.sh <python versions>``, make sure
all tests pass before submitting a patch
-* Add an entry to the ChangeLog describing the change
+- Add an short entry to the ChangeLog describing the change
-* Take care of the commit message
+- Write a comprehensive commit message
-* Relate your change to a tracker issue
+- Relate your change to an issue in the tracker
-If you don't want to bother with mercurial, you can still create a diff and
-post it to the mailing list or as attachment to a tracker issue.
+- Send a pull request from bitbucket