"Fossies" - the Fresh Open Source Software Archive

Member "pmd-src-6.48.0/CONTRIBUTING.md" (30 Jul 2022, 3407 Bytes) of package /linux/misc/pmd-src-6.48.0.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

A hint: This file contains one or more very long lines, so maybe it is better readable using the pure text view mode that shows the contents as wrapped lines within the browser window.


How to contribute to PMD

First off, thanks for taking the time to contribute!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

You can find the code of conduct in the file code_of_conduct.md.

NB: the rule designer is developed over at pmd/pmd-designer. Please refer to the specific contributor documentation if your issue, feature request or PR touches the designer.

Pull requests

Bug reports

We use the issue tracker on Github. Please report new bugs at https://github.com/pmd/pmd/issues.

When filing a bug report, please provide as much information as possible, so that we can reproduce the issue:

Documentation

There is some documentation available under https://pmd.github.io/latest. Feel free to create a bug report if documentation is missing, incomplete or outdated. See Bug reports.

The documentation is generated as a Jekyll site, the source is available at: https://github.com/pmd/pmd/tree/master/docs. You can find build instructions there. For more on contributing documentation check https://pmd.github.io/pmd/pmd_devdocs_writing_documentation.html

Questions

There are various channels, on which you can ask questions:

Code Style

PMD uses checkstyle to enforce a common code style.

See pmd-checkstyle-config.xml for the configuration and the eclipse configuration files that can be imported into a fresh workspace.

Add yourself as contributor

We use All Contributors.

To add yourself to the table of contributors, follow the bot usage instructions ;).

Or use the CLI:

  1. Install the CLI: npm i (in PMD’s top level directory)
  2. Add yourself: npx all-contributors add <username> <contribution>

Where username is your GitHub username and contribution is a ,-separated list of contributions. See Emoji Key for a list of valid types. Common types are: “code”, “doc”, “bug”, “blog”, “talk”, “test”, “tutorial”.

See also cli documentation