squizlabs / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
10.66k stars 1.48k forks source link

Improve available CONTRIBUTING information and guidelines #3830

Closed jrfnl closed 9 months ago

jrfnl commented 1 year ago

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.md file 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

DannyvdSluijs commented 1 year ago

Even though I've approved the PR I now realise this MR will probably break the link to the Contributing.md mentioned in the README.md (see https://github.com/squizlabs/PHP_CodeSniffer#contributing)

jrfnl commented 1 year ago

Even though I've approved the PR I now realise this MR will probably break the link to the Contributing.md mentioned in the README.md (see https://github.com/squizlabs/PHP_CodeSniffer#contributing)

Good catch! Thanks for that. I've fixed that up in the commit which moves the file now.

jrfnl commented 10 months ago

Note: depending on which PR gets merged first, this PR will need an update for the changes in #3803.

jrfnl commented 9 months ago

Closing as replaced by (merged PR) https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/40