2.1 KiB
Contributing
Contributions are welcome and desirable, in the form of:
- Bug reports (raise an issue)
- Feature requests (raise an issue)
- Code (submit a Pull Request)
- Comments (comment on any of the above)
Before you start any Pull Request, it's recommended that you raise an issue first if you have any doubts. That way you can be sure that the maintainer(s) agree on what to change and how, and you can hopefully get a quick merge afterwards.
Running the source code locally
After you have cloned the project, first check that it's running OK locally.
First you will need to install dependencies. We use yarn so run yarn instead of npm install.
renovate supports nodejs versions 6.11.1 and above. It is written using async/await so needs babel transpilation for nodejs 6. It is planned to drop support for nodejs 6 once nodejs 8 reaches LTS.
If running in nodejs 6, you need to run a transpiled version of the code. You can do this without an explicit transpilation step by running yarn run start-babel. Do not make the mistake of running yarn run start !
Examples:
$ yarn run start-babel username/reponame
$ LOG_LEVEL=trace yarn run start-babel username/reponame
$ yarn run start-babel -- --labels=foo username/reponame
If running on node 8, you can run just like the above, but use the yarn run start-raw command instead of yarn run start-babel.
Adding configuration options
We wish to keep backwards-compatibility as often as possible, as well as make the code configurable, so most new functionality should be controllable via configuration options. Please see Configuration docs for a list of current options.
If you wish to add one, add it to lib/config/definitions.js and then run yarn run update-docs.
Running tests
You can run yarn test locally to test your code. We also run Continuous Integration using CircleCI.
We use Prettier for code formatting. If your code fails yarn test due to a prettier rule in eslint then it can be fixed by running yarn run lint-fix;