WCEU 2020 Contributor Day Wrap Up

For the very first online 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 Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. Documentation team had two virtual Zoom rooms, one for end user documentation, facilitated by @bph, and the other for developer documentation, facilitated by @leogermani.

We had total of 4 new contributors, evenly distributed in our Zoom rooms.

The most interest went to BlockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. Editor end user documentation. This work is under review.

Work on redirecting Functions code reference from Codex to DevHub is nearing its completeness: 92.2%.

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 Developer Handbook was reviewed for content that is not limited to plugins development, during which page about HTTPHTTP HTTP is an acronym for Hyper Text Transfer Protocol. HTTP is the underlying protocol used by the World Wide Web and this protocol defines how messages are formatted and transmitted, and what actions Web servers and browsers should take in response to various commands. APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. has been split into several sections and planned to be moved to Common APIs Handbook.

Block Editor developer documentation will soon be enriched with a tutorial on Creating a block. This tutorial is meant for all junior and PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. http://php.net/manual/en/intro-whatis.php. developers trying to bridge development practices before Block Editor and new ways of building with WordPress.

A warm welcome to @kmeze, @femkreations, @peteringersoll and @lvg2013. Thank you for joining Documentation team.

Also, huge thanks to all new and more experienced contributors and team members who joined us during WCEU 2020 Contributor Day: @kenshino, @atachibana, @sukafia, @bph, @leogermani, @mkaz, @estelaris, @tacitonic, @cguntur, @makewebbetter, @chaion07, @softservenet, @bobbingwide, @kartiks16, @fierevere, @garrett-eclipse, @saiftheboss7, @wernerm274, @JeremyG, @Glauber Silva, @Lev N, @Taha Qureshi, @ruchitshah.

I apologise if I missed someone or if your username at 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/. and WordPress.orgWordPress.org 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/ is not the same and I couldn’t find the latter. Let me know in comments and I’ll add or modify it.

Thank you everyone and hope to see you all in person at some other Contributor Day(s) where we can share the cookies and hugs. Until then stay safe and take care of yourselves.

#contributor-day, #wceu, #wceu2020

WCEU Contributor Day

How to prepare for Contributor Day?

In order to contribute to any team at WordPress.orgWordPress.org 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/, it is necessary to have:

All communication for Documentation team is happening in #docs 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/. channel. Different parts of documentation are called “projects”. Each of these projects has own rep (team member in charge of the project).

Different projects require different tools so, depending on what you choose, you might need following accounts as well:

If you wish to attend our introduction conference call on the day, you’ll need to use Zoom as well. The account is not needed and you can join the call in your browser or you can download the app. You don’t need camera nor microphone to participate.

Read more about contributing to Documentation team at Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. here.

Good First Tasks

If you are contributing to Documentation team for the first time, we prepared lists of “Good first tasks” for our projects.

If you are experienced Documentation contributor fear not, we have more advanced tasks on these lists as well.

Take a look at these lists and let us know what you’re interested in. Even if your point of interest is not on the list, do let us know what it is.

Contributor Day, 4 June

Contributor Day will happen online. All instructions can be found here. Besides that, if you registered for WCEU Contributor Day, you’ll receive more detailed instructions in your email on the day.

To help you get started, we’ll hold an one hour introduction on Zoom. In this call we will introduce the team and give you more details on what we were planning to do during the day. If you have something specific you’d like to work on, this call would be a good time to propose it.

The easiest way to get involved is reporting an issue, if you have found one. We have step-by-step lists for reporting issues for every project.

More advanced way for contributing to Documentation team would be fixing reported issues. We still haven’t documented these workflows but you will be provided with assistance by project’s rep. See the full list of reps.

If you need any help or have questions, team members will be available in Slack throughout the Contributor Day.

Contributor Day Facilitators

Documentation team is very friendly and welcoming. If you have any questions whatsoever, do not hesitate to ask. In Slack channel or during Zoom call, someone will answer it before you say “Cookie”.

Besides all lovely contributors to Documentation, we have a list of people who volunteered to give their time and facilitate different Documentation projects during WCEU Contributor Day:

  • @leogermani for DevHub (developer docs)
  • @Sunday Ukafia  for onboarding and everything regarding new contributors
  • @bph for blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. editor end user docs
  • @atachibana for HelpHub (general end user docs) as long as East Asian time zone allows

I will be there the whole day, you can’t avoid that, happily answering all your questions and guiding you to a new directions. We will also see @kenshino there as well.

Office hours, 28 May

Documentation team will hold office hours on Thursday, May 28, 2020, 15:00 UTC. Office hours will be facilitated by @sukafia and you are welcome to ask any questions about Documentation team and how to contribute to various parts of WordPress documentation.

Office hours will be held in #docs channel (WordPress.org Slack account is needed). If you are not able to attend, feel free to ask all your questions in channel and team members will respond as soon as possible.

#contributor-day, #wceu

Docs Team Preparation for WCEU 2020 Contributor Day

WCEU 2020 will be held online and it will have the biggest Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. done fully remote. This is challenging in many ways for everyone involved: organisers, team reps and teams, new contributors.. 

To help prevent some of foreseen problems, organisers offered a set of tasks for each team to be done in following days. 

Here’s what we have to do:

  1. Update the Getting Started at a Contributor Day page in handbook (polyglots teamPolyglots Team Polyglots Team is a group of multilingual translators who work on translating plugins, themes, documentation, and front-facing marketing copy. https://make.wordpress.org/polyglots/teams/. made a good example)
  2. Schedule European timezones friendly office hours taking place in 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/. between 25 May and 3 June, targeted to answer questions from new contributors and help them to set up tools. This is a good opportunity to test our mentorship program.
  3. Choose an experienced contributor(s) from the team to record a short video introduction about the team. These videos will replace the traditional live introductions given during opening remarks and also used in the Contributor Day Orientation tool. Detailed guides for making these videos will be shared in the coming weeks. 
  4. Divide the tasks planned for the day between ‘good first tasks’ and ‘tasks for experienced contributors’. Make sure that every new contributor gets an easy task first. An example of how the Community Team does this: Call for ideas and plans for the day.
  5. Choose at least two experienced contributors to facilitate the work during the day, to help new contributors and to answer their questions quickly and happily.
  6. Plan an introductory session to help onboard new contributors to your team. The team-specific introductory sessions will take place after opening remarks. Another one for our mentorship program.
  7. Make a rough estimate of how many working groups your team needs during the day. Working groups are contributors working together with specific tasks or features, who will need a dedicated virtual table/space for discussion. This information is crucial for WCEU in planning platform usage and layout.

Leave your thoughts and suggestions in the comments and we will discuss these in the next meeting, on Monday 11th May.

#contributor-day, #wceu

Summary for Docs Team Meeting: January 27, 2020

Facilitator: @kulsumsiddique

Attendance: @kenshino, @bph, @felipeelia, @kulsumsiddique, @audrasjb, @ibdz, @wpza, @felipeloureirosantos, @nullbyte, @kafleg, @atachibana, @nobnob

Note-taker: @audrasjb

Next week Facilitator: @kenshino (but invite for other meeting facilitator is open, please comment below if interested)

Team workflow and badges

@felipeelia: workflow docs are being constructed on TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing.. @milana_cap is the one to ask for access if needed.

Badges are being discussed in this P2 post. The contributor badge has been discussed for a while now, trying to reach a number of X micro contributions. On his last comment there, @felipeelia suggested to give the badge right away, just as in CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. and MetaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress.. @bph added that there is precedent on other teams and make the contributor badge seen right away: it’s the best onboarding tool we have.

@bph proposed a list of elligible contributions:

  • Fix an article
  • Create meeting notes
  • facilitate a meeting
  • reporting an issue on the comment form?
  • Creating a PR for GutenbergGutenberg 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 ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ docs
  • user notes on code reference
  • write an article on HelpHub
  • update an article on HelpHub
  • migrate a page to DevHub
  • Report an issues

@kenshino shared some worries about relevancy: “if we say that fixing a typo is fine – we’ll have a rush of requests to do that to farm badges”. Indeed, Core and Meta have automated system to give props to people who contribute on TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/., based on commit messages. There is no such system for Docs.

@felipeelia argued that 1) People receive core/meta badges sending a 1-line patch ; 2) Coming in to Docs 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/. team and reporting a small typo does require some effort. @bph added that working out how to communicate a fix to the Docs team is a significant step. even if the contribution is just a typo fix. @kenshino agreed, but the team must keep an eye on abuse to tighten those rules if needed.

Regarding Team Badges, @kenshino proposed to set up a sheet and to give edit access to people that are running projects within the Docs Team.

HelpHub Survey

Reminder from previous meeting discussions: The goal is to build the questions of the survey with the general theme being “How do you think we can improve the WordPress documentation?”. Some questions using the likert scale to track how good it is now so the Team can repeat the survey in the future. Some open fields to get proper feedback so it’s possible to define future projects better. That would be great for this survey to be ready for 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. Asia, in less than one month.

@atachibana is coordinating the effort. @bph proposed to assist on this task.

Step 1 is to start a Google Doc in the team’s shared folder.

This survey and the Docs team focus for WordCamp Asia are set to be the next meeting focus.

@bph proposed to draft a P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. post to ask for questions proposals. @kenshino proposed to review this draft.

#contributor-day, #helphub

WCSF Contributor Day

We’ve made plans to work on completing both the developer handbooks during our two day team meetupMeetup All local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. following WCSF.

I’d like to use this thread to discuss ideas on what Docs tasks we can have contributors work on during Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. on Sunday.

This is a good opportunity to have contributors work on non-handbook tasks that also need to be completed.

A couple possibilities are:

  • Code Reference MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies.: migration of content from the Codex code references to the new code reference, including reviewing content, adding examples, and setting up redirects from the Codex.
  • Codex cleanup: review of Codex content – editing, truncating, deleting pages that are out of date.

If you have other suggestions, please add them in the comments. Also indicate whether you’ll be available to work with new contributors on Sunday.

#contributor-day, #wcsf2014

Learned about helping out and getting started with…

Learned about helping out and getting started with documentation this past weekend 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. LA. Edited my first page in the theme handbook and looking forward to digging in some more 🙂 I’m a designer, not a developer, so I’m focusing on clarity and ease of understanding, consistency in formatting, etc.

I do have some questions about formatting for consistency, such as:

  • Sometimes things are capitalized and sometimes the same thing isn’t … so, what should be capitalized and what should not? (i.e. post, page, Post Type, Custom Post typeCustom Post Type WordPress can hold and display many different types of content. A single item of such a content is generally called a post, although post is also a specific post type. Custom Post Types gives your site the ability to have templated posts, to simplify the concept.)
  • In a list of items, if not in a bulleted list, do you want the comma used before the “and” or not?
  • In a bulleted or numbered list, should each item have an initial cap or not?
  • And regarding consistency in bolding, should code references (i.e. post_type) use a bold or regular style?

I’m sure I’ll have other questions as I go, but I’m looking forward to digging in, reading all your hard work, & learning! Oh, and please let me know if I do something wrong or mess anything up … just a little nervous about getting started 🙂

#contributor-day

I’m at WordCamp LA Contribute day We’re looking…

I’m 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. LA Contribute day. We’re looking over pages and cleaning up typos and language (not finding many problems) I’ve been looking at pages for The LoopLoop The Loop is PHP code used by WordPress to display posts. Using The Loop, WordPress processes each post to be displayed on the current page, and formats it according to how it matches specified criteria within The Loop tags. Any HTML or PHP code in the Loop will be processed on each post. https://codex.wordpress.org/The_Loop., Theme Functions, etc

#contributor-day

Contributing this fine WordPress Weekend

There are two events particularly relevant to the docs team coming up this weekend:

WP Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. in Manchester, UK

The newly formed WP Contributor Day group is running their first event on March 1st from 10AM – 6PM UTC, @johnbillon has written a post with more details. The event’s site is at WPContributorDay.com.

For docs folks in particular, if you’re in the north of England, why not head on over? It’s sure to be a great day, whatever your skills or experience level.

If you’re elsewhere, and already familiar with contributing then joining in virtually via #wordpress-sfd would be a fantastic thing to do.

Monthly Docs Sprint in Seattle, USA

The Seattle MeetupMeetup All local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. group are hosting their monthly Docs Sprint on Saturday, too. It’s running from 10AM – 2PM PST.

It’s been a while since we’ve mentioned the additional virtual nature of these sprints here on the blog, so for the benefit of newer contributors, here’s some of the backstory.

In short: the meet-up group welcomes your participation, wherever you may be!

To quote @sewmyheadon, here’s what do to if you’re not in the Seattle area:

Online: If you’re bashful, or simply outside of the Seattle area, you can simply logon to the IRC channel at #wordpress-sfd and participate from anywhere.

Why not take a peek at the getting started page for the handbooks to gather inspiration for your contributing this coming weekend?

Happy weekend, docs!

#contributor-day

Handbook Tasks – WordCamp Sofia Contributor Day 2013

Howdy 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. Sofia Contributors!

Thanks a bunch for helping with WordPress documentation – we all really appreciate your help!

We’ve been focusing a lot on the Theme Developer Handbook and Plugin Developer Handbook, which both need a good deal of work.

For most people, the toughest roadblock to contributing is just getting started, so hopefully this will help.

Where to Go

The jumping off point for all docs-related efforts is: make.wordpress.org/docs/ – In the sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme., you’ll see links to the Handbooks along with the Spreadsheets we use to track their progress.

  1. The Theme Developer Handbook is at: http://bit.ly/WPThemeHB
    • . . . and the spreadsheet that we use to track Theme Developer Handbook progress is at: http://bit.ly/WPThemeHB_Content
  2. The 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 Developer Handbook is at: http://bit.ly/WPPluginHB
    • . . . and the spreadsheet that we use to track Plugin Developer Handbook progress is at: http://bit.ly/WPPluginHB_Content
  3. The IRC channel we use is at #wordpress-sfd on Freenode.
    • This is a great place to ask questions, post links to docs for review, and cheer each-other on.

Getting Started

If you haven’t already, you’ll want to:

  1. Read the Handbook Style Guide
  2. Review the Handbook Tutorial Template
  3. Find a topic in the Theme or Plugin developer spreadsheet that interests you
  4. Check the Needs column of the spreadsheet to see if there are specific things that are needed in this document
  5. Add your name to the Responsible column in the spreadsheet
  6. Write or edit in HTMLHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. or Markdown and give it to Mario Peshev or email it over to me at eric [at] ivycat.com and we’ll post for you.

What if I’m not a Writer?

If you’re not comfortable writing or editing, you can also help by:

  • Creating code snippets for examples
  • Taking relevant screenshots
  • Reading existing documentation and making comments regarding improvements

If you’re completely overwhelmed and not sure where to start, you might start by reading through the Handbook and, when you’ve got questions, find missing content, or see improvements, please feel free to work on the document, or make comments in that document’s comment section.

I’m here to help in any way I can, so feel free to pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” me (@sewmyheadon) or Mario (@no_fear_inc), or post to the #wordpress-sfd IRC channel if you have any questions.

Thanks again and have a great WordCamp!

#contributor-day, #docs, #wcsofia

Inline Docs Tasks – WC Sofia Contributor Day 2013

For those of you contributing to Inline Docs during Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. Sofia 2013, we thank you. 🙂

The Inline Docs initiative is a part of the overall effort to build a new code reference that will live at developer.wordpress.orgWordPress.org 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/. Creating inline documentation for hooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same. will provide the information necessary to populate that portion of the code reference.

What You Need To Know

Please read the PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. http://php.net/manual/en/intro-whatis.php. Documentation Standard section on documenting Hooks (Actions and Filters) to familiarize yourself with how the actual doc blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. should be formatted, and how duplicate hooks should be documented.

  • The Documenting Tips section covers recommended language when writing descriptions, as well how to determine the version for @since, and guidelines for Code Refactoring.
  • The Formatting Guidelines section covers how to format the text in the descriptions.

Opening A Ticket > Getting Started > Trac Preferences explains how to log in to Trac with your WordPress.org username, and how to configure your email address in Trac preferences so that you receive TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket notifications.

Working With Patches covers creating patches using the command line and TortoiseSVN (for Windows users). If you are using GitGit 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. https://git-scm.com/., please follow the creating patches guide at Contributing to WordPress Using Github by Scribu.

How to Contribute

We have reserved 15 files for the WC Sofia contributors to work on, and have tagged them (Reserved-WC Sofia) on the Add Inline Docs for Hooks post. The files are:

  • wp-admin/network/edit.php
  • wp-admin/network/settings.php
  • wp-admin/network/site-new.php
  • wp-admin/network/site-settings.php
  • wp-admin/network/users.php
  • wp-admin/user/admin.php
  • wp-admin/includes/export.php
  • wp-admin/includes/menu.php
  • wp-admin/includes/template.php
  • wp-admin/includes/theme.php
  • wp-includes/functions.wp-scripts.php
  • wp-includes/functions.wp-styles.php
  • wp-admin/press-this.php
  • wp-admin/update.php
  • wp-admin/user-edit.php

The following are the steps you need to follow:

1. Leave a comment on the Make/Core post with the name of the file you are going to work on.

2. Update your local WordPress SVN or Git repo (use git pull) to the latest version of WordPress trunk (currently 3.8-alpha).

3. Create a new ticket on Trac for the file.

new_docs_ticket_labeled

  • Format the title as “Hooks Docs: path/to/file.php”.
  • The Type should be “defect (bug)”.
  • Assign the ticket to the “Inline Docs” component.
  • Leave the Version blank.
  • The Severity should be “normal”.
  • Add your wordpress.org username or email address to the CC: field so you’ll receive activity notifications for your ticket.

4. Edit the file, and make a patch. Please make sure you create the patch from the root directory of your WordPress SVNSVN Apache Subversion (often abbreviated SVN, after its command name svn) is a software versioning and revision control system. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS). WordPress core and the wordpress.org released code are all centrally managed through SVN. https://subversion.apache.org/. or Git checkout.

5. Upload your patch to the Trac ticket you created, and add the keyword “has-patch”.

Patch Review Process

1. We will review your patch, and may make recommendations for changes that need to be made. We will change the ticket keyword to “needs-patch” if changes are needed.

2. Please read the review, ask for clarification if needed, then make the requested changes, and create a new patch.

3. Use the same filename for your revised patch, and upload it to the ticket. Remove the “needs-patch” keyword, and add the “has-patch” keyword.

  • Note: Do not check the box next to Replace existing attachment of the same name – it is preferred to have copies of all attachments submitted to preserve the history of the ticket. Trac will automatically append an incremental number (xxxxx.2.diff) to the end of a patch filename to prevent an accidental overwrite of the existing file, in cases where the same patch is submitted multiple times due to needed changes.

We will review the updated patch, and may request further changes, if needed. Repeat steps 2 and 3 until we say your patch is good, and we tag it as “commit”.

Congratulations, and thank you for contributing to WordPress! 🙂

#contributor-day, #inline-docs, #wcsofia