|author||Piotrek Żygieło <email@example.com>||Sun Oct 27 20:40:40 2019 +0100|
|committer||Piotrek Żygieło <firstname.lastname@example.org>||Sun Oct 27 20:40:40 2019 +0100|
(doc) Update references to PMD documentation Follow-up to https://github.com/pmd/pmd/commit/04b0859fb2 (pmd_releases/6.3.0-123-g04b0859fb2)
You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code, there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us:
git diff --checkbefore committing.
[MPMD-XXX] - Subject of the JIRA Ticket Optional supplemental description.
mvn -Prun-its verifyto assure nothing else was accidentally broken.
If you plan to contribute on a regular basis, please consider filing a contributor license agreement.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. In this case, it is appropriate to start the first line of a commit with ‘(doc)’ instead of a ticket number.