Good first issues

If this is your first time contributing to the Documentation team we have various kinds of good first issues that can help you get started give you idea of what contributing to WordPress documentation might look like.

Updating screenshots

Most of articles have accompanying screenshots, which have to be updated every time a new WordPress version change something in that particular part of user interface. To create new screenshots, you’ll need a fresh install of the latest WordPress version. The easiest ways of doing this is using either WordPress Playground or InstaWP service.

It is important that WordPress is in English and no additional plugins, or custom themes are used – only the default theme and settings. New screenshots should cover the same area of the screen as the old screenshots do so that change is clearly visible.

Top ↑

Updating videos

Same as with screenshots, many articles have videos or GIF images, showcasing the described feature. These should be updated if they are showing the feature or screen area that has changed in the most recent WordPress version.

Top ↑

Checking headings capitalization

As a part of our official documentation Style guide, all headings must be in a sentence case. To check these, open the article and take a look at all the headings. Copy the ones that don’t comply and paste them in the GitHubGitHub 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 ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ issue you’re working on.

Top ↑

Checking image ALT attributes

Every image that appears in WordPress documentation has to have an ALT attribute. This is a part of our Accessibility guidelines. In the source code it can be found as alt="":

<img ... alt="" ... />

If there’s no text inside the quotes, then the ALT attribute is considered empty and this is something we want to avoid. It should look something like this:

<img ... alt="This is the ALT attribute." ... />

In order to see the source code, you should right click on the image and select “Inspect”. It will open the source code and highlight the selected image tag.

Last updated: October 31, 2023