Let’s update the Core handbook! Sprints start June 20, 2022

In just a few weeks, the community empanels a new release squad to take on the focused work of WordPress 6.1, due in mid-October.

Some parts of the CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. handbook are need of review and update, especially to reflect big changes in how WordPress works — and in the way WordPress is made. This is hoped to also assist more people to be able to follow or get involved with releases and tickets. During the last few months, there has been some time spent on going through the handbook in preparation for contributor events at WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Europe and WordCamp US, as well as exploring how it can help new contributors get involved with the project. During recent release cycles, a number of handbook updates have been made or identified for further work.

So on Monday June 20, 2022 at 20:00 UTC, @webcommsat and @marybaum will host the first of a series of sprints devoted to the Core handbook. It will be held in the #core SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/.. There will be opportunities to continue with the sprint asynchronously.

@webcommsat has been working behind the scenes to support contributors in different timezones get involved in the review, information gathering, and editing process. She is also identifying cross-links with relevant materials in the documentation and support blogs, and Learn WordPress. A spreadsheet and google docs will be shared on Monday and will be available for asynchronous contribution, and added to this post. The first sprint will be reviewed on Wednesday June 22, 2022 before the weekly dev chat meeting.

Please consider this post your personal invitation to get involved!

Finding a live collaboration session time that will suit everyone is always difficult, so we are proposing a series of dates and will be promoting asynchronous opportunities too:

It is also hoped to get feedback from the new contributor sessions.

If you want to help, have input for a particular page in the handbook, or can help with facilitating a live sprint, please add a comment to this post.

Thank you to @webcommsat for helping organize the events and to @meher and others for the review of the post.

#core-contributor-handbook

Looking for a lead

The CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. Contributor Handbook is live here, and has a lot of great content from a number of contributors already:

https://make.wordpress.org/core/handbook/

What we’re looking for is someone to “own” the CCH and be responsible for:

  • Expanding and editing it, getting feedback from devs.
  • Walking people through it to get ideas on how to improve it (and get people involved with WP!).
  • Soliciting other contributors (don’t want a one-person show) and keeping an eye on all the changes.
  • Figure out a cool way to package and print the handbook.

Let me know if you’re interested in taking on this role, a comment on this post is fine.

This also reminds me — it would be great to be able to see a feed of changes on a site, like edits to a page. Anyone have a favorite pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party there?

#core-contributor-handbook

Write a tutorial for setting up a local dev environment

A section of the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. contributor handbook will be about how to set up a local test install, including a web server, Subversion, and WordPress. Because of the various operating systems and software packages out there, we’re going to need a few different tutorials.

I need some people willing to write up procedures for a number of standard setups. This includes:

  • WordPress on XAMPP (both Windows and Mac) MAMP, and MacPorts
  • TortoiseSVN and a tutorial on command-line Subversion usage, including co, up, revert, diff; patchpatch A special text file that describes changes to code, by identifying the files and lines which are added, removed, and altered. It may also be referred to as a diff. A patch can be applied to a codebase for testing.; conflicts, etc.
  • Whatever you Linux guys use 🙂

I’d also love an article on getting the test suite up and running. Anything I’m missing?

So, for these procedures, people can volunteer (probably for their current setup). Once steps are written, others will need to test them. Many procedures may heavily borrow from or link to outside resources (such as the vendor sites themselves) — this is fine. And, there may already be some good things in the Codex or on other sites about getting WordPress running. Again, fine. (There are SVNSVN Subversion, the popular version control system (VCS) by the Apache project, used by WordPress to manage changes to its codebase. articles by both @westi and @markjaquith, and those are probably great to start from.) Gather links, screenshots, further reading, whatever will help.

So, who is in?

#core-contributor-handbook

A glossary for contributors

As part of the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. contributor handbook, there’s going to be a glossary. Here’s what I’ve put together so far.

Something missing? Leave a comment. Feel free to also weigh in on new and existing definitions, examples, and the like.

a11yAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility): AccessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility), or the act of ensuring that user interfaces are accessible for persons of all abilities and disabilities.

back compatback compat Backward compatibility - a desire to ensure that plugins and themes do not break under new releases - is a driving philosophy of WordPress. While it is a commonly accepted software development practice to break compatibility in major releases, WordPress strives to avoid this at all costs. Any backward incompatible change is carefully considered by the entire core development team and announced, with affected plugins often contacted. It should be noted that external libraries, such as jQuery, do have backward incompatible changes between major releases, which is often going to be a greater concern for developers.: Backwards compatibility — a desire to ensure that plugins and themes do not break under new releases — is a driving philosophy of WordPress. While it is a commonly accepted software development practice to break compatibility in major releases, WordPress strives to avoid this at all costs. Any backwards incompatible change is carefully considered by the entire core development team and announced, with affected plugins often contacted. It should be noted that external libraries such as jQuery do have backwards incompatible changes between major releases, which is often going to be a greater concern for developers.

backportbackport A port is when code from one branch (or trunk) is merged into another branch or trunk. Some changes in WordPress point releases are the result of backporting code from trunk to the release branch.: A port is when code from one branchbranch A directory in Subversion. WordPress uses branches to store the latest development code for each major release (3.9, 4.0, etc.). Branches are then updated with code for any minor releases of that branch. Sometimes, a major version of WordPress and its minor versions are collectively referred to as a "branch", such as "the 4.0 branch". (or trunktrunk A directory in Subversion containing the latest development code in preparation for the next major release cycle. If you are running "trunk", then you are on the latest revision.) is merged into another branch or trunk. Some changes in WordPress point releases are the result of backporting code from trunk to the release branch.
Continue reading

#core-contributor-handbook

What do core contributors need to know?

I’ll be working on an outline for the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. contributor handbook in the coming weeks, so I figured I would start a brainstorming session here. Some potential questions to ask yourself:

  • What do core contributorsCore Contributors Core contributors are those who have worked on a release of WordPress, by creating the functions or finding and patching bugs. These contributions are done through Trac. https://core.trac.wordpress.org. need to know?
  • What would have been great to know when you first started getting involved?
  • What resources (such as pages on the Codex) have you found useful?
  • What do people (including/especially non-contributors) need to know about the development process/cycle/philosophies?

#3-org, #core-contributor-handbook