Skip to content

Conversation

@jeffpaul
Copy link
Member

@jeffpaul jeffpaul commented Nov 22, 2025

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:

  • Added CODE_OF_CONDUCT.md to define expected behavior and enforcement procedures for contributors, adopting the Contributor Covenant standard.

Project History and Recognition:

  • Added CHANGELOG.md to track notable changes, releases, and version history following the Keep a Changelog and Semantic Versioning standards.
  • Added CREDITS.md to 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

Before After

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.

@jeffpaul jeffpaul added this to the 0.1.0 milestone Nov 22, 2025
@jeffpaul jeffpaul requested review from desrosj and dkotter November 22, 2025 01:38
@jeffpaul jeffpaul self-assigned this Nov 22, 2025
@jeffpaul jeffpaul moved this to Needs review in WordPress AI Planning & Roadmap Nov 22, 2025
@github-actions
Copy link

github-actions bot commented Nov 22, 2025

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: desrosj <desrosj@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Member

@desrosj desrosj left a 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:

Screenshot 2025-11-21 at 10 11 54 PM Screenshot 2025-11-21 at 10 11 47 PM

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.
@jeffpaul
Copy link
Member Author

@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?

@jeffpaul jeffpaul requested a review from desrosj November 22, 2025 19:07
Copy link
Member

@desrosj desrosj left a 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.

jeffpaul and others added 2 commits November 25, 2025 14:32
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.
@jeffpaul jeffpaul merged commit 3cf1f72 into trunk Nov 25, 2025
16 of 22 checks passed
@jeffpaul jeffpaul deleted the add/community-files branch November 25, 2025 20:35
@github-project-automation github-project-automation bot moved this from Needs review to Done in WordPress AI Planning & Roadmap Nov 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

4 participants