|
| 1 | +This document outlines some processes that the maintainers should stick to. |
| 2 | + |
| 3 | +## Issues Process |
| 4 | + |
| 5 | +There are 3 types of issues that can be created: |
| 6 | + |
| 7 | +- `"bug"` |
| 8 | +- `"new rule"` |
| 9 | +- `"enhancement"` |
| 10 | + |
| 11 | +### Triage |
| 12 | + |
| 13 | +The triage process is basically making sure that the issue is correctly reported (and ask for more info if not), and categorize it correctly if it belongs to a different type than initially assigned. |
| 14 | + |
| 15 | +- When a new issue is created, they'll include a `"triage"` label |
| 16 | +- If the issue is correctly reported, please remove the `"triage"` label, so we know is valid and ready to be tackled |
| 17 | +- If the issue is **not** correctly reported, please ask for more details and add the `"awaiting response"` label, so we know more info has been requested to the author |
| 18 | +- If the issue belong to an incorrect category, please update the labels to put it in the right category |
| 19 | +- If the issue is duplicated, please close it including a comment with a link to the duplicating issue |
| 20 | + |
| 21 | +## Pull Requests Process |
| 22 | + |
| 23 | +### Main PR workflow |
| 24 | + |
| 25 | +_TODO: pending to describe the main PR process_ |
| 26 | + |
| 27 | +### Contributors |
| 28 | + |
| 29 | +When the PR gets merged, please check if the author of the PR or the closed issue (if any) should be added or updated in the [Contributors section](https://github.com/testing-library/eslint-plugin-testing-library#contributors-). |
| 30 | + |
| 31 | +If so, you can ask the [`@all-contributors` bot to add a contributor](https://allcontributors.org/docs/en/bot/usage) in a comment of the merged PR (this works for both adding and updating). Remember to check the [Contribution Types table](https://allcontributors.org/docs/en/emoji-key) to decide which sort of contribution should be assigned. |
| 32 | + |
| 33 | +## Stale bot |
| 34 | + |
| 35 | +This repo uses [probot-stale](https://github.com/probot/stale) to close abandoned issues and PRs after a period of inactivity. |
| 36 | + |
| 37 | +They'll be considered inactive if they match all the following conditions: |
| 38 | + |
| 39 | +- they have been 60 days inactive |
| 40 | +- they have at least one of the following labels: |
| 41 | + - `"awaiting response"`: we are waiting for more details but the author didn't react |
| 42 | + - `"new rule"`: there is a proposal for a new rule that no one could handle |
| 43 | + - `"enhancement"`: there is a proposal for an enhancement that no one could handle |
| 44 | + - `"invalid"`: something is wrong with the issue/PR and the author didn't take care of it |
| 45 | + |
| 46 | +When flagged as a stale issue or PR, they'll be definitely closed after 7 more days of inactivity. Issues and PRs with the following labels are excluded: `"pinned"`, `"security"`, and "`triage"`. Use the first one if you need to exclude an issue or PR from being closed for whatever reason even if the inactive criteria is matched. |
0 commit comments