Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CONTRIBUTING: add table of contents + note about cc list #417

Merged
merged 2 commits into from
Mar 28, 2024
Merged

CONTRIBUTING: add table of contents + note about cc list #417

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
876125f
CONTRIBUTING: add table of contents
jrfnl Mar 18, 2024
cf42e5b
CONTRIBUTING: add note about the community cc-list
jrfnl Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ Contributing
Thank you for your interest in contributing to PHP_CodeSniffer!


## Table of Contents

* [Reporting Bugs](#reporting-bugs)
- [Reporting Security Issues](#reporting-security-issues)
- [Support/Questions About Using PHP_CodeSniffer](#supportquestions-about-using-php_codesniffer)
* [Contributing Without Writing Code](#contributing-without-writing-code)
- [Bug Triage](#bug-triage)
- [Testing Open Pull Requests](#testing-open-pull-requests)
- [Writing sniff documentation](#writing-sniff-documentation)
- [Other tasks](#other-tasks)
* [Contributing With Code](#contributing-with-code)
- [Requesting/Submitting New Features](#requestingsubmitting-new-features)
- [Getting started](#getting-started)
- [While working on a patch](#while-working-on-a-patch)
- [Writing tests](#writing-tests)
- [Submitting your pull request](#submitting-your-pull-request)
* [Licensing](#licensing)


## Reporting Bugs

Please search the [open issues](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues) to see if your issue has been reported
Expand Down Expand Up @@ -149,6 +168,17 @@ This is an open invitation for interested parties to gather their thoughts about
> Kind request: If you don't have something to add to the discussion, but do want to indicate a positive or negative opinion
> on a topic, please add an emoji on the original post instead of leaving a comment.

> :bulb: On a subset of these issues - the ones which impact maintainers or integrators -, a list of known interested parties
> will be pinged (cc-ed) to gather their thoughts on the topic.
>
> This list is public and
> [maintained in a markdown file](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/community-cc-list.md).
>
> To add or remove yourself to/from this list, submit a PR to the repo updating the `community-cc-list.md` file.
> PRs adding/removing _other people_ to/from the list will only be merged if the people being added/removed leave a comment
> on the PR consenting to it.


#### Issues marked with "Status: needs investigation"

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