Skip to content

Commit 846fbf0

Browse files
authored
Merge pull request #417 from PHPCSStandards/feature/contributing-add-note-about-cc-list
CONTRIBUTING: add table of contents + note about cc list
2 parents 726b9b8 + cf42e5b commit 846fbf0

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ Contributing
44
Thank you for your interest in contributing to PHP_CodeSniffer!
55

66

7+
## Table of Contents
8+
9+
* [Reporting Bugs](#reporting-bugs)
10+
- [Reporting Security Issues](#reporting-security-issues)
11+
- [Support/Questions About Using PHP_CodeSniffer](#supportquestions-about-using-php_codesniffer)
12+
* [Contributing Without Writing Code](#contributing-without-writing-code)
13+
- [Bug Triage](#bug-triage)
14+
- [Testing Open Pull Requests](#testing-open-pull-requests)
15+
- [Writing sniff documentation](#writing-sniff-documentation)
16+
- [Other tasks](#other-tasks)
17+
* [Contributing With Code](#contributing-with-code)
18+
- [Requesting/Submitting New Features](#requestingsubmitting-new-features)
19+
- [Getting started](#getting-started)
20+
- [While working on a patch](#while-working-on-a-patch)
21+
- [Writing tests](#writing-tests)
22+
- [Submitting your pull request](#submitting-your-pull-request)
23+
* [Licensing](#licensing)
24+
25+
726
## Reporting Bugs
827

928
Please search the [open issues](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues) to see if your issue has been reported
@@ -149,6 +168,17 @@ This is an open invitation for interested parties to gather their thoughts about
149168
> Kind request: If you don't have something to add to the discussion, but do want to indicate a positive or negative opinion
150169
> on a topic, please add an emoji on the original post instead of leaving a comment.
151170
171+
> :bulb: On a subset of these issues - the ones which impact maintainers or integrators -, a list of known interested parties
172+
> will be pinged (cc-ed) to gather their thoughts on the topic.
173+
>
174+
> This list is public and
175+
> [maintained in a markdown file](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/community-cc-list.md).
176+
>
177+
> To add or remove yourself to/from this list, submit a PR to the repo updating the `community-cc-list.md` file.
178+
> PRs adding/removing _other people_ to/from the list will only be merged if the people being added/removed leave a comment
179+
> on the PR consenting to it.
180+
181+
152182
#### Issues marked with "Status: needs investigation"
153183

154184
Sometimes an issue has been identified, but it has not yet been pinpointed what the exact cause of the problem is.

0 commit comments

Comments
 (0)