Skip to content
Snippets Groups Projects
Commit 3f633d8f authored by Rhys Arkins's avatar Rhys Arkins Committed by GitHub
Browse files

chore: update contributing.md (#895)

fixes a few incorrect/outdated commands.
parent bd263169
No related branches found
No related tags found
No related merge requests found
......@@ -7,7 +7,7 @@ Contributions are welcome and desirable, in the form of:
- Code (submit a Pull Request)
- Comments (comment on any of the above)
Before you submit any code, 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.
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
......@@ -15,18 +15,19 @@ After you have cloned the project, first check that it's running OK locally.
First you will need to install dependencies. We use [yarn](https://github.com/yarnpkg/yarn) so run `yarn` instead of `npm install`.
`renovate` supports node versions 6.9 and above. It is written using async/await so needs `babel` transpilation for node 6.
`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` !
If running in node 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`.
Examples:
```sh
$ yarn run start-babel username/reponame
$ LOG_LEVEL=verbose 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 7, you can run just like the above, but use the `yarn run start-raw` command instead of `yarn run start-babel`.
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
......@@ -39,4 +40,4 @@ If you wish to add one, add it to `lib/config/definitions.js` and then run `yarn
You can run `yarn test` locally to test your code. We also run Continuous Integration using CircleCI.
We use [Prettier](https://github.com/prettier/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 eslint-fix`;
We use [Prettier](https://github.com/prettier/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`;
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment