-
Notifications
You must be signed in to change notification settings - Fork 24
Add/community files #95
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
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
desrosj
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, we do not want most of the community health files supported in the special .github repository to be added to individual repositories.
The .github repository provides the default versions of each supported file for the entire organization and allowing the policy to be updated in a singular location. Adding the file to individual repositories overrides the default one and the ability to update a single file when there are changes is lost.
The default files are shown as a tab through the web UI where the README file is displayed after the file list, and linked to in the sidebar of the project:
The exceptions to this list are:
- Discussion category forms - Most repositories do not use this, but they will likely need to be unique to each repo.
- Issue and pull request templates and config.yml - Different projects require different information for issues and pull requests.
SUPPORT.md- there is no one-size-fits-all support process. It's reasonable for each individual repository to define this.
For some history on this, see:
The SECURTY.md file does not exist in the special repository. I've created WordPress/.github#6 to tackle that. Once (if) one is added, then a separate PR can be opened to remove the one in this repo.
Clarified contribution expectations and linked to the Code of Conduct.
|
@desrosj I've removed the CoC file here and added a link to the .github one in the readme, that should cover things from your review yeah? |
desrosj
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had a few suggestions, but looks good overall.
Co-authored-by: Jonathan Desrosiers <359867+desrosj@users.noreply.github.com>
Expanded the credits section to include a note about the WordPress Core's 'give props liberally' policy and the use of the Props Bot.
What?
Relates to #28.
This pull request adds important documentation files to the project, establishing clear guidelines for contributions, credits, and project changes. These updates help clarify project history, contributor recognition, and expected standards for community interaction.
Documentation and Community Standards:
CODE_OF_CONDUCT.mdto define expected behavior and enforcement procedures for contributors, adopting the Contributor Covenant standard.Project History and Recognition:
CHANGELOG.mdto track notable changes, releases, and version history following the Keep a Changelog and Semantic Versioning standards.CREDITS.mdto acknowledge maintainers, contributors, and libraries used in the project, improving transparency and recognition.One question, pinging @desrosj directly, is whether we want to go with this Code of Conduct file here or perhaps link directly to https://github.com/WordPress/.github/blob/trunk/CODE_OF_CONDUCT.md from the README.md here instead (as that appears to perhaps be a broad WordPress project-wide CoC file)?
Why?
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
Test using WordPress Playground
The changes in this pull request can be previewed and tested using this WordPress Playground instance:
Click here to test this pull request.