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.

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

Improve available CONTRIBUTING information and guidelines #40

Merged
merged 3 commits into from
Nov 9, 2023

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Nov 9, 2023

Description

Recreation of upstream PR squizlabs/PHP_CodeSniffer#3830 with some additional tweaks:

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

... 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 jrfnl added this to the 3.8.0 milestone Nov 9, 2023
@jrfnl jrfnl merged commit a97cfb4 into master Nov 9, 2023
53 checks passed
@jrfnl jrfnl deleted the feature/contributing-improvements branch November 9, 2023 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant