Skip to content

Commit

Permalink
docs: Audit and streamline CONTRIBUTING.md (#5120)
Browse files Browse the repository at this point in the history
  • Loading branch information
santoshyadavdev committed Sep 3, 2022
1 parent 4cbdc30 commit 5c58a02
Showing 1 changed file with 66 additions and 8 deletions.
74 changes: 66 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,32 @@

Feel free to raise an issue if you have a question, an enhancement, or a bug report.

Use the issue search functionality to search all **_opened and closed_** issues before raising a new issue. If you raise a duplicate issue, you're just creating noise for everyone watching this repo.
Use the issue search functionality to search all **_opened and closed_** [issues](https://github.com/typescript-eslint/typescript-eslint/issues) before raising a new issue. If you raise a duplicate issue, you're just creating noise for everyone watching this repo.

Before raising a bug, ensure you are using the latest version of our packages. We release every week, so there's a good chance your issue might have already been fixed.

Finally, when raising a new issue, please fill out the issue template - **_please don't skip sections_**.
Finally, when raising a new issue, please fill out the [issue template](https://github.com/typescript-eslint/typescript-eslint/issues/new/choose) - **_please don't skip sections_**.

Please provide **_as much information as possible_**. This project is maintained by volunteers, so the more information you provide, the less likely we will have to waste everyone's time in asking you for more information.

If you have a particularly complex issue - consider creating a small, self-contained reproduction repo. This will help you in figuring out the exact problem, and will help us in reproducing and diagnosing the bug.
If you have a particularly complex issue - consider creating a small, self-contained reproduction repo or use our [playground](https://typescript-eslint.io/play). This will help you in figuring out the exact problem, and will help us in reproducing and diagnosing the bug.

**_Help us to help you_**

## Questions and requests for support

Questions and requests for support should not be opened as issues and should be handled in the following ways:

- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript-eslint) using the `typescript-eslint` tag.
- Join our [Discord server](https://discord.com/invite/??).

## Commenting

Feel free to comment on any open issue if you have more information that you feel like you can provide. If you don't have more information, instead use the "reaction" feature on the root comment for the issue. We use reactions to help gauge which issues are important to the community, so these are the best way to show us an issue is important.

Please refrain from leaving useless comments on issues. Comments like "+1", or "when's this getting fixed", or "any progress on this" just serve as spam, and annoy every single person subscribed to the issue. Generally we will just delete those comments, so save everyone time and think twice.

Please refrain from commenting on old, closed issues and PRs. Your issue is rarely related enough to a closed issue to warrant "necroing" a dead thread - raising a new issue means you can fill in the template, and make it easier for us to help you. Often times if you comment on a closed issue, we will just ask you to open a new issue, so please save everyone's time, and **_help us to help you_**.
Please refrain from commenting on old, closed issues and PRs. Your issue is rarely related enough to a closed issue to warrant "necroing" a dead thread - raising a new issue means you can fill in the [template]((https://github.com/typescript-eslint/typescript-eslint/issues/new/choose)), and make it easier for us to help you. Often times if you comment on a closed issue, we will just ask you to open a new issue, so please save everyone's time, and **_help us to help you_**.

Please refrain from commenting on `main` commits. Commit comments are not searchable, meaning that nobody else can discover your comments. Raise an issue and reference the commit instead so that everyone can see your comment, and you can fill out the template.

Expand Down Expand Up @@ -70,20 +77,39 @@ We have a sophisticated CI process setup which gets run on every PR. You must pa
Once your changes are ready, you can raise a PR. The title of your PR should match the following format:

```text
<tag>(<package>): <short description>
<type>(<package>): <Subject> (#Issue Number)
```

Samples: (even more [samples](https://github.com/typescript-eslint/typescript-eslint/commits/main))

```text
fix(scope-manager): correct handling for class static blocks
```

Where `<tag>` is one of:
```text
docs: Fix links to getting started in README.md
```

### Revert

If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

### Type

Must be one of the following:

- `feat` - for any new functionality additions
- `fix` - for any bug fixes that don't add new functionality
- `test` - if you only change tests, and not shipped code
- `docs` - if you only change documentation, and not shipped code
- `chore` - anything else

And `<package>` is the name of the package you have made changes within (`eslint-plugin`, `parser`, `typescript-estree`, etc). If you make significant changes across multiple packages, you can omit this (i.e. `feat: foo bar`).
### package

And `<short description>` is a succinct title for the PR.
`<package>` is the name of the package you have made changes within (`eslint-plugin`, `parser`, `typescript-estree`, etc). If you make significant changes across multiple packages, you can omit this (i.e. `feat: foo bar`).

### Subject
And `<Subject>` is a succinct title for the PR.

Within the body of your PR, make sure you reference the issue that you have worked on, as well as pointing out anything of note you wish us to look at during our review.

Expand All @@ -100,3 +126,35 @@ With your PR raised, and the CI showing green, your PR will [sit in the queue to
Please note that as this project is maintained by volunteers, it may take a while for us to get around to your PR (sometimes a month or more). Be patient, we'll get to it. Please refrain from commenting asking for a review, or similar bump comments. **_These just create spam for maintainers, and does not push your PR higher in the queue_**.

Once we have reviewed your PR, we will provide any feedback that needs addressing. If you feel a requested change is wrong, don't be afraid to discuss with us in the comments. Once the feedback is addressed, and the PR is reviewed, we'll ensure the branch is up to date with `main`, and merge it for you.


## Financial contributions

We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/typescript-eslint).
Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

### Contributors

Thank you to all the people who have already contributed to typescript-eslint!
<a href="https://github.com/typescript-eslint/typescript-eslint/graphs/contributors"><img src="https://opencollective.com/typescript-eslint/contributors.svg?width=890" /></a>

### Backers

Thank you to all our backers! [[Become a backer](https://opencollective.com/typescript-eslint#backer)]

<a href="https://opencollective.com/typescript-eslint#backers" target="_blank"><img src="https://opencollective.com/typescript-eslint/backers.svg?width=890"></a>

### Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/typescript-eslint#sponsor))

<a href="https://opencollective.com/typescript-eslint/sponsor/0/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/1/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/2/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/3/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/4/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/5/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/6/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/7/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/8/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/typescript-eslint/sponsor/9/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/9/avatar.svg"></a>

0 comments on commit 5c58a02

Please sign in to comment.