summaryrefslogtreecommitdiff
path: root/doc/contribute.rst
diff options
context:
space:
mode:
authorSylvain Thénault <sylvain.thenault@logilab.fr>2013-04-17 10:33:52 +0200
committerSylvain Thénault <sylvain.thenault@logilab.fr>2013-04-17 10:33:52 +0200
commit88dc9daedb6cf3cf4ed073311caf0c3b93fa9009 (patch)
treecc4f0fdd0cf9f5fee660b376088c5d97a75bb01f /doc/contribute.rst
parent575b69cfb37548e596f41715f60384e752b994a9 (diff)
downloadpylint-git-88dc9daedb6cf3cf4ed073311caf0c3b93fa9009.tar.gz
[doc] redo some of my changes after rebasing nico's changes; rm former manual/quickstart
Diffstat (limited to 'doc/contribute.rst')
-rw-r--r--doc/contribute.rst44
1 files changed, 28 insertions, 16 deletions
diff --git a/doc/contribute.rst b/doc/contribute.rst
index 762e3513d..20dd8e4b8 100644
--- a/doc/contribute.rst
+++ b/doc/contribute.rst
@@ -15,16 +15,16 @@ discuss Pylint issues, see below for more information about Pylint's related
lists.
You can check for already reported bugs, planned features on Pylint's tracker
-web page: http://www.logilab.org/project/pylint
+web page: https://bitbucket.org/logilab/pylint/issues
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
astng and common:
-* http://www.logilab.org/project/logilab-astng
+* https://bitbucket.org/logilab/astng/issues
* http://www.logilab.org/project/logilab-common
-.. _`tracker page`: http://www.logilab.org/project/pylint
+.. _`tracker page`: https://bitbucket.org/logilab/pylint/issues
Mailing lists
-------------
@@ -51,17 +51,25 @@ generic forum-fr@logilab.org mailing list:
Notice though that this list has a very low traffic since most Pylint related
discussions are done on the python-projects mailing list.
+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
- hg clone http://www.logilab.org/src/pylint
- hg clone http://www.logilab.org/src/logilab/astng
- hg clone http://www.logilab.org/src/logilab/common
+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/
@@ -69,15 +77,19 @@ Got a patch for Pylint? There a few steps you must take to make sure your
patch gets accepted.
* Test your code
+
* 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 versions>``, make sure
+
+ * In the test folder of pylint run ./fulltest.sh (python version), make sure
all tests pass before submitting a patch
-* Create a diff file
- * To create a diff from the command line invoke (from a directory under
- version control) ::
- hg diff > <yourname>.diff
+* Add an entry to the ChangeLog describing the change
+
+* Take care of the commit message
+
+* Relate your change to a tracker issue
-* E-mail the mailing list with your diff file
+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.