{"id":111019,"date":"2024-02-01T20:09:17","date_gmt":"2024-02-01T20:09:17","guid":{"rendered":"https:\/\/make.wordpress.org\/core\/?p=111019"},"modified":"2024-02-02T17:18:55","modified_gmt":"2024-02-02T17:18:55","slug":"new-commit-message-requirements-in-git-hello-props-bot","status":"publish","type":"post","link":"https:\/\/make.wordpress.org\/core\/2024\/02\/01\/new-commit-message-requirements-in-git-hello-props-bot\/","title":{"rendered":"New Commit Message Requirements in Git: Hello Props Bot"},"content":{"rendered":"

Note: This post was updated to correct the format used in one example and remove references to the wapuu<\/code> w.org username (not officially associated with the project). A note was also added under a list saved as a synced pattern to indicate the contents of the list may change over time. 2\/2\/2024 \u2013 @<\/span>desrosj<\/a><\/em><\/p>\n\n\n\n

In January 2022, a proposal was published on this blog<\/a> to implement a new process within any GitHubGitHub<\/span> GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the \u2018pull request\u2019 where code changes done in branches by contributors can be reviewed and discussed before being merged by the repository owner. https:\/\/github.com\/<\/a><\/span><\/span><\/span> repository under the WordPress organization to ensure anyone and everyone contributing to the project receives due thanks in the form of \u201cprops.\u201d The post is still almost entirely accurate and it\u2019s recommended you read that in full. Here are some highlights.<\/p>\n\n\n\n

One of the greatest things about open sourceOpen Source<\/span> Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL.<\/span><\/span><\/span> is that contributions come in many shapes and sizes. Anyone can contribute regardless of skill set, experience, time zone, or background. There are countless ways for someone to get involved with open source projects.<\/p>\n\n\n\n

WordPress is no different. Contributors submitting code modifications are only a small subset of the larger community. Recognizing all types of contributions is essential to establishing a healthy contributor base, and the responsibility falls on the project\u2019s maintainers. Contributors who feel recognized and valued are more likely to continue contributing.<\/p>\n\n\n\n

There is an established and documented policy<\/a> on the TracTrac<\/span> An open source project by Edgewall Software that serves as a bug tracker and project management tool for WordPress.<\/span><\/span><\/span>\/SVNSVN<\/span> Subversion, the popular version control system (VCS) by the Apache project, used by WordPress to manage changes to its codebase.<\/span><\/span><\/span> side of the project to ensure that everyone contributing to a changeset receives credit (or \u201cprops\u201d). This method has been in place for over 12 years, making generating the list of props for each release scriptable and straightforward. The process is unique to the project but frequently receives positive feedback from others in open source<\/a>.<\/p>\n\n\n\n

Since being merged into WordPress CoreCore<\/span> Core is the set of software required to run WordPress. The Core Development Team builds WordPress.<\/span><\/span><\/span> in version 5.0, there has yet to be an equivalent process for the contributions on GitHub. The process is manual, does not account for non-code contributions, and often results in contributors not receiving credit for their work.<\/p>\n\n\n\n

The post documents the state of props practices and related processes in detail for both Trac\/SVN and GitHub. No major changes have been made to these practices since the publish date of that post.<\/p>\n\n\n\n

After taking into account all of the feedback received from that proposal, a new policy is now in place for maintainers.<\/p>\n\n\n\n

New requirement for GutenbergGutenberg<\/span> The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses \u2018blocks\u2019 to add richness rather than shortcodes, custom HTML etc.\rhttps:\/\/wordpress.org\/gutenberg\/<\/a><\/span><\/span><\/span> GitHub merge commit messages<\/h2>\n\n\n\n

Starting today, it is required that GitHub merge commit messages for Gutenberg include credits for all contributors following the same guidance as Core SVN commits:<\/p>\n\n\n\n

\n

Props should be given to all those who contributed to the final commit, whether through patches, refreshed patches, code suggested otherwise, design, writing, user testing, or other significant investments of time and effort.<\/p>\n<\/blockquote>\n\n\n\n

In Core SVN, this is done as Props x, y, z.<\/code> In GitHub, this will be done using Co-authored-by<\/code> trailers. To avoid having personal emails in the commit log of the project (or having to know which personal email someone has associated with their GitHub account at a given time), a contributor\u2019s GitHub and WordPress.orgWordPress.org<\/span> The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https:\/\/wordpress.org\/<\/a><\/span><\/span><\/span> usernames should be used in the following format:<\/p>\n\n\n\n

Co-authored-by: githubusername <dotorgusername@git.wordpress.org><\/code><\/p>\n\n\n\n

This practice defines a consistent expected pattern that can be reliably parsed by a script to collect contributions for a repository from a GitGit<\/span> Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system.\rhttps:\/\/git-scm.com\/<\/a><\/span><\/span><\/span> log in the same fashion as the Core SVN repository.<\/p>\n\n\n\n

In order to make this new practice easier for committers and maintainers, a new tool has been merged into the code bases.<\/p>\n\n\n\n

Introducing Props Bot<\/h2>\n\n\n\n

Props Bot<\/a> is a new GitHub Action that will compile a list of contributors for a given pull request. The bot will leave a comment with a list of contributors formatted for use in both Trac SVN and GitHub.<\/p>\n\n\n\n

The comment will be continuously updated as new activity occurs. Additionally, the bot can be manually run by adding the props-bot<\/code> label to the pull request.<\/p>\n\n\n\n

Types of activity included:<\/p>\n\n\n\n