-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2272 from Mindful-AI-Assistants/FabianaCampanari-…
…patch-1 contributing_renovate.md
- Loading branch information
Showing
1 changed file
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
# Contributing | ||
|
||
## Security / Disclosure | ||
|
||
If you find any bug with Renovate that may be a security problem, then e-mail us at: [[email protected]](mailto:[email protected]). | ||
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. | ||
|
||
## Support | ||
|
||
If you want help with your Renovate configuration, go to the [discussions tab in the Renovate repository](https://github.com/renovatebot/renovate/discussions) and open a new "config help" discussion post. | ||
|
||
## Bug Reports and Feature Requests | ||
|
||
**Bugs**: First search for related bugs in the issues and discussions, if you don't find anything then: | ||
|
||
1. Create a [minimal reproduction](https://github.com/renovatebot/renovate/blob/main/docs/development/minimal-reproductions.md) | ||
1. Open a new _discussion_ and link to the minimal reproduction | ||
|
||
For **feature requests**: first search for related requests in the issues and discussions, if you don't find anything: create a _discussion_. | ||
|
||
## Rate Limiting of Support Requests through Temporary Blocking | ||
|
||
To ensure that the Renovate maintainers don't burn out from dealing with unfriendly behavior, those who display a bad attitude when asking for or receiving support in the repo will be rate limited from further requests through the use of temporary blocking. | ||
The duration of the temporary block depends on how rude or inconsiderate the behavior is perceived to be, and can be from 1-30 days. | ||
|
||
If you have been blocked temporarily and believe that it is due to a misunderstanding, or you regret your comments and wish to make amends, please reach out to the lead maintainer Rhys Arkins by email with any request for early unblocking. | ||
If/once you are unblocked, you should edit or delete whatever comment lead to the blocking, even if you did not intend it to be rude or inconsiderate. | ||
Long emails or apologies are undesirable - the maintainers are busy and want to be able to help as many users as possible with the time they have available. | ||
|
||
## Code | ||
|
||
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](../docs/development/local-development.md). | ||
Also skim the [docs/development](../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](https://github.com/renovatebot/renovate/discussions) 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. | ||
|
||
### Tests | ||
|
||
Pull Requests can only be merged once all status checks are green, which means `pnpm test` passes, and coverage is 100%. | ||
|
||
Use these commands to help run your tests: | ||
|
||
- To run a single test folder, specify the path | ||
|
||
```bash | ||
pnpm jest platform/gitlab | ||
``` | ||
|
||
- To run against a single test file, specify down to the filename (suffix is not necessary) | ||
|
||
```bash | ||
pnpm jest platform/gitlab/index | ||
``` | ||
|
||
- To run a single test batch, the `-t` value must be part of the `describe` value of the test batch | ||
|
||
```bash | ||
pnpm jest platform/gitlab/index -t "getJsonFile" | ||
``` | ||
|
||
- To run a single test, the `-t` value must be part of the `it` value of the test batch | ||
|
||
```bash | ||
pnpm jest platform/gitlab/index -t "returns file content from given repo" | ||
``` | ||
|
||
And some options: | ||
|
||
- `--verbose=false` to avoid the test list | ||
- `--collectCoverage=false` to avoid collecting coverage, faster for the part you need the test to pass | ||
|
||
## 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're updating your PR branch from within the GitHub PR interface, use the default "Update branch" button. | ||
This is the "Update with merge commit" option in the dropdown. | ||
Force pushing a PR, or using the "Update with rebase" button is OK when you: | ||
- make large changes on a PR which require a full review anyway | ||
- 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: | ||
1. Batch the suggestions into a logical group by selecting the **Add suggestion to batch** button | ||
1. Select the **Commit suggestions** button | ||
Read the [GitHub docs, Applying suggested changes](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes) to learn more. | ||
## Resolve review comments instead of commenting | ||
A maintainer/contributor can ask you to make changes, without giving you a _suggestion_ that you can apply. | ||
In this case you should make the necessary changes. | ||
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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#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](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review). | ||
|
||
|