Skip to content

Commit 676112c

Browse files
committed
Adding additional info to README file to help out contributors
1 parent 0701798 commit 676112c

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,32 @@ prospector [..other options..]
3636
* Validates `Model.__unicode__` methods.
3737
* `Meta` informational classes on forms and models do not generate errors.
3838

39+
# Contributing
40+
41+
Please feel free to add your name to the `CONTRIBUTORS.md` file if you want to be
42+
credited when pull requests get merged. You can also add to the `CHANGELOG.md` file
43+
if you wish, although I'll also do that when merging if not.
44+
45+
## Tests
46+
47+
The structure of the test package follows that from pylint itself.
48+
49+
It is fairly simple: create a module starting with `func_` followed by
50+
a test name, and insert into it some code. The tests will run pylint
51+
against these modules. If the idea is that no messages now occur, then
52+
that is fine, just check to see if it works by running `scripts/test.sh`.
53+
54+
Ideally, add some pylint error suppression messages to the file to prevent
55+
spurious warnings, since these are all tiny little modules not designed to
56+
do anything so there's no need to be perfect.
57+
58+
It is possible to make tests with expected error output, for example, if
59+
adding a new message or simply accepting that pylint is supposed to warn.
60+
the `messages` directory contains a list of files which should match the
61+
name of the test and contain error type, line number, class and expected text.
62+
These are useful to quickly add "expected messages".
63+
64+
3965
# License
4066

4167
`pylint-django` is available under the GPLv2 license.

0 commit comments

Comments
 (0)