- Fork the project from https:/pivotal/LicenseFinder
- Create a feature branch.
- Make your feature addition or bug fix. Please make sure there is appropriate test coverage.
- Rebase on top of master.
- Send a pull request.
There are a few steps to adding a new package manager.
Here is how
support was added for rebar, an erlang package manager.
Add new licenses to lib/license_finder/license/definitions.rb. There are
existing tools for matching licenses; see, for example, the MIT license, which
can be detected in many different ways.
If you need license_finder to output additional package data, consider
submitting a pull request which adds new columns to
lib/license_finder/reports/csv_report.rb.
It is also possible to generate a custom report from an ERB template. Use this
example as a starting
point. These reports will have access to the helpers in
LicenseFinder::ErbReport.
If you need a report with more detailed data or in a different format, we recommend writing a custom ruby script. This example will get you started.
If you come up with something useful, consider posting it to the Google Group [email protected].
To successfully run the test suite, you will need npm, maven, pip, gradle and
bower installed. If you run rake check_dependencies, you'll see exactly what
you're missing.
For the python dependency tests you will want to have virtualenv installed, to allow pip to work without sudo. For more details, see this post on virtualenv.
You'll need a pip version >= 6.0.
If you're running the test suite with jruby, you're probably going to want to set up some environment variables:
JAVA_OPTS='-client -XX:+TieredCompilation -XX:TieredStopAtLevel=1' JRUBY_OPTS='-J-Djruby.launch.inproc=true'
You'll need a gradle version >= 1.8.