Improve available CONTRIBUTING information and guidelines #3830
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fredden
reviewed
May 19, 2023
jrfnl
force-pushed
the
feature/contributing-improvements
branch
from
f34c017
to
1ce2c4e
Compare
fredden
approved these changes
May 19, 2023
12 tasks
gsherwood
reviewed
May 27, 2023
jrfnl
force-pushed
the
feature/contributing-improvements
branch
from
1ce2c4e
to
806f69a
Compare
DannyvdSluijs
approved these changes
Sep 4, 2023
|
Even though I've approved the PR I now realise this MR will probably break the link to the |
... which is nowadays the more common location for this type of file. Includes updating the link in the README file. Ref: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
These scripts should make contributing to PHPCS more straight-forward as they document common CI checks and allow for running these locally.
This is a rewrite of the `CONTRIBUTING.md` file to document expectations and opportunities for contributors. It also answers some common questions previously received from contributors.
jrfnl
force-pushed
the
feature/contributing-improvements
branch
from
806f69a
to
25ab851
Compare
Good catch! Thanks for that. I've fixed that up in the commit which moves the file now. |
|
Note: depending on which PR gets merged first, this PR will need an update for the changes in #3803. |
5 tasks
|
Closing as replaced by (merged PR) PHPCSStandards/PHP_CodeSniffer#40 |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
CONTRIBUTING: move file to .github directory
... which is nowadays the more common location for this type of file.
Includes updating the link in the README file.
Ref: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
Composer: add scripts for contributors
These scripts should make contributing to PHPCS more straight-forward as they document common CI checks and allow for running these locally.
CONTRIBUTING: rewrite the contributing guide
This is a rewrite of the
CONTRIBUTING.mdfile to document expectations and opportunities for contributors.It also answers some common questions previously received from contributors.
Suggested changelog entry
N/A
Related issues/external references
N/A
Types of changes