mirror of
https://fuchsia.googlesource.com/third_party/github.com/pylint-dev/pylint
synced 2024-09-22 08:33:42 +00:00
84 lines
2.9 KiB
ReStructuredText
84 lines
2.9 KiB
ReStructuredText
|
.. -*- coding: utf-8 -*-
|
||
|
|
||
|
============
|
||
|
Contribute
|
||
|
============
|
||
|
|
||
|
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.
|
||
|
|
||
|
You can check for already reported bugs, planned features on Pylint's tracker
|
||
|
web page: http://www.logilab.org/project/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
|
||
|
astng and common:
|
||
|
|
||
|
* http://www.logilab.org/project/logilab-astng
|
||
|
* http://www.logilab.org/project/logilab-common
|
||
|
|
||
|
.. _`tracker page`: http://www.logilab.org/project/pylint
|
||
|
|
||
|
Mailing lists
|
||
|
-------------
|
||
|
|
||
|
Use the python-projects@logilab.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.
|
||
|
|
||
|
You can subscribe to this mailing list at
|
||
|
http://lists.logilab.org/mailman/listinfo/python-projects
|
||
|
|
||
|
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:
|
||
|
|
||
|
* (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.
|
||
|
|
||
|
|
||
|
Forge
|
||
|
-----
|
||
|
|
||
|
Pylint is developped using the mercurial_ distributed version control system.
|
||
|
|
||
|
You can clone Pylint and its dependencies from ::
|
||
|
|
||
|
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
|
||
|
|
||
|
.. _mercurial: http://www.selenic.com/mercurial/
|
||
|
|
||
|
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
|
||
|
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
|
||
|
|
||
|
* E-mail the mailing list with your diff file
|