We'd love to accept your patches and contributions to this project. There are just a few guidelines you need to follow which are described in detail below.
You should create a fork of this project in your account and work from there. You can create a fork by clicking the fork button in GitHub.
Work for each new feature/issue should occur in its own branch. To create a new branch from the command line:
git checkout -b my-new-featurewhere "my-new-feature" describes what you're working on.
Use Maven to build the project and verify that projects compiles properly. This project was currently tested with Java 8 and Java 11.
$ mvn clean installBefore opening a pull request, ensure that your new code conforms to the code style as defined by the .editorconfig file in the project.
Use NPM to build the project and verify that projects starts properly.
$ npm install
$ npm run build:exampleVerify build functions correctly.
$ npm install
$ npm run buildRun the Jarviz CLI and verify it successfully generates the dependency coupling graph.
$ ./jarviz graph -f samples/filter.json -a samples/artifacts.jsonPlease make sure that the new changes are covered by unit tests.
Please add appropriate documentation in the README and source code. Also please ask the maintainers to update the wiki with any relevant information.
Create a new pull request and your code will be reviewed by the maintainers. They will confirm at least the following:
- Tests run successfully (unit, coverage, integration, code style, etc.).
- Contribution policy has been followed.
A maintainer will need to sign off on your pull request before it can be merged.