Skip to content

Commit aeb53ae

Browse files
authored
Merge pull request #169 from PHPCSStandards/feature/enhance-contributor-info
Enhance/improve info for contributors
2 parents 797679a + 2c6a547 commit aeb53ae

File tree

2 files changed

+37
-9
lines changed

2 files changed

+37
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ The [discussion forum](https://github.com/PHPCSStandards/PHP_CodeSniffer/discuss
3636

3737
## Contributing Without Writing Code
3838

39-
### Issue Triage
39+
### Bug Triage
4040

41-
We welcome issue triage.
41+
We welcome bug triage.
4242

43-
Issue triage is the action of verifying a reported issue is reproducible and is actually an issue.
44-
This includes checking whether the issue is something which should be fixed in **_this_** repository.
43+
Bug triage is the action of verifying a reported bug is reproducible and is actually an issue.
44+
This includes checking whether the bug is something which should be fixed in **_this_** repository.
4545

46-
To find issues which need triage, look for [issues without labels](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) or issues with the ["Status: triage"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20triage) label.
46+
To find bugs which need triage, look for issues and PRs with the ["Status: triage"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20triage) label.
4747

48-
#### Typical issue triage tasks:
49-
* Verify whether the issue is reproducible with the given information.
48+
#### Typical bug triage tasks:
49+
* Verify whether the bug is reproducible with the given information.
5050
* Ask for additional information if it is not.
5151
* If you find the issue is reported to the wrong repo, ask the reporter to report it to the correct external standard repo and suggest closing the issue.
5252

@@ -74,7 +74,7 @@ To get access to a PHPCS version which includes the patch from a pull request, y
7474

7575
### Writing sniff documentation
7676

77-
Sniffs in PHP_CodeSniffer should preferably be accompanied by documentation. There is currently still a lot of documentation missing.
77+
Sniffs in PHP_CodeSniffer should preferably be accompanied by documentation. There is currently still a lot of [documentation missing](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/148).
7878

7979
Sniff documentation is provided via XML files in the standard's `Docs` directory and is available to end-users via the command-line and/or can be compiled into an HTML or Markdown file.
8080

@@ -117,6 +117,31 @@ phpcs --standard=StandardName --generator=Text --sniffs=StandardName.Category.Sn
117117
Kind request to add only one new XML file per PR to make the PR easier to review.
118118

119119

120+
### Other tasks
121+
122+
There are also tasks looking for contributions, which don't necessarily fall into the above categories.
123+
124+
#### Issues marked with "Status: waiting for opinions"
125+
126+
Proposals for new features, proposals for (structural) changes to PHP_CodeSniffer itself or to the contributor workflow, will initially be marked with the ["Status: waiting for opinions"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20waiting%20for%20opinions) label.
127+
128+
This is an open invitation for interested parties to gather their thoughts about the issue and to leave their opinion.
129+
130+
> 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.
131+
132+
#### Issues marked with "Status: needs investigation"
133+
134+
Sometimes an issue has been identified, but it has not yet been pinpointed what the exact cause of the problem is.
135+
136+
Other times, like with syntax changes in PHP itself, PHP_CodeSniffer _may_, or _may not_, handle them correctly and this will need verification.
137+
138+
Issues like these will be marked with the ["Status: needs investigation"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20needs%20investigation) and investigating those can be a good way to learn more about the source code of PHP_CodeSniffer.
139+
140+
#### Issues marked with "Status: help wanted"
141+
142+
If you don't know where to start, having a browse through issues marked with the ["Status: help wanted"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20help%20wanted) and/or the ["Status: good first issue"](https://github.com/PHPCSStandards/PHP_CodeSniffer/labels/Status%3A%20good%20first%20issue) labels.
143+
144+
120145
## Contributing With Code
121146

122147
### Requesting/Submitting New Features

.github/pull_request_template.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ Describe your changes in detail and, if relevant, explain which choices you have
1212

1313

1414
## Suggested changelog entry
15-
<!-- Please provide a short description of the change for the changelog. -->
15+
<!--
16+
Please provide a short description of the change for the changelog.
17+
This is only needed when this is an end-user, integrators or external standard maintainers facing change.
18+
-->
1619

1720

1821
## Related issues/external references

0 commit comments

Comments
 (0)