Security / Disclosure
If you find any bug with Renovate that may be a security problem, then e-mail us at: email@example.com. This way we can evaluate the bug and hopefully fix it before it gets abused. Please give us enough time to investigate the bug before you report it anywhere else.
Please do not create GitHub issues for security-related doubts or problems.
If you want help with your Renovate configuration, go to the discussions tab in the Renovate repository and open a new "config help" discussion post.
Bug Reports and Feature Requests
If you've found a bug or have a feature request then please create an issue in this repository (but search first in case a similar issue already exists).
If you would like to fix a bug or work on a feature, please fork the repository and create a Pull Request. To learn how to setup your local workstation correctly read docs/development/local-development.md. Also skim the docs/development folder, it has a lot of helpful information on things like adding a new package manager, how Renovate branches work, design decisions and more.
Before you start any Pull Request, it's recommended that you open a discussion first if you have any doubts about requirements or implementation. 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. Also, let the maintainers know that you plan to work on a particular issue so that no one else starts any duplicate work.
Pull Requests can only be merged once all status checks are green, which means
yarn test passes, and coverage is 100%.
Do not force push to your pull request branch
Please do not force push to your PR's branch after you have created your PR, as doing so forces us to review the whole PR again. This makes it harder for us to review your work because we don't know what has changed. PRs will always be squashed by us when we merge your work. Commit as many times as you need in your pull request branch.
If you are updating your PR branch from within the GitHub PR interface, then only use the default "Update branch" button.
Force pushing a PR is OK when:
- you need to make large changes on a PR which require a full review anyway
- you need to bring the branch up-to-date with the target branch and incorporating the changes is more work than to create a new PR
Apply maintainer provided review suggestions
Maintainers can suggest changes while reviewing your pull request, please follow these steps to apply them:
- Batch the suggestions into a logical group by selecting the Add suggestion to batch button
- Select the Commit suggestions button
Read the GitHub docs, Applying suggested changes to learn more.
Resolve review comments instead of commenting
A maintainer/contributor can ask you to make changes, without providing a suggestion that you can apply. In this case you need to do some work yourself to address the feedback.
Once you've done the work, resolve the conversation by selecting the Resolve conversation button in the PR overview. Avoid posting comments like "I've done the work", or "Done".
Read the GitHub Docs, resolving conversations to learn more.
Re-requesting a review
Please do not ping your reviewer(s) by mentioning them in a new comment. Instead, use the re-request review functionality. Read more about this in the GitHub docs, Re-requesting a review.
Slack collaboration with maintainers
The codebase can be difficult to navigate, especially for a first-time contributor. We don't want you spending an hour trying to work out something that would take us only a minute to explain.
For that reason, we have a Slack channel dedicated to helping anyone who's working on or considering Pull Requests for Renovate. Please email firstname.lastname@example.org and simply mention that you need an invitation to the channel and you'll be added ASAP.
Important: this Slack group is restricted to development questions only in order to keep the volume of messages lower - all technical support questions should still be posted to this repository's Discussions instead.
Pull Request authors must sign the Renovate CLA.
If you cannot or do not want to sign this CLA (e.g. your employment contract for your employer may not allow this), you should not submit a PR. Open an issue and someone else can do the work.