Skip to content

Commit

Permalink
Added development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ChuckJonas committed Feb 21, 2020
1 parent 7eb2f3c commit b999aed
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,22 @@ NOTE: If you move away from the default ruleset in an sfdx project, make sure to

If you want to use your own [custom rules](https://pmd.github.io/latest/pmd_userdocs_extending_writing_pmd_rules.html) from a jar file, then the jar file must be on the classpath. By default, the PMD folder and the workspace root folder are included in the classpath. You can add further folders using the `additionalClassPaths` setting. This ["Hello world"](https://github.com/andrewgilbertsagecom/pmd-custom-rule-sample) example is a good starting place for beginners.

## Developing/Contributing

### Setup & Run

1. `git clone`
1. `npm install`
1. debug -> "launch extension"

### Upgrading PMD

- Download latest distribution
- unzip
- copy contents (`bin`, `lib`,`LICENSE`) to `bin/pmd`

Any pull request submitted with updates to PMD MUST BE "CHECKSUMED"!

## Legal Stuff

```
Expand Down

0 comments on commit b999aed

Please sign in to comment.