Write or Update GatherPress Documentation

GatherPress is an open-source event and 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. 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. for WordPress. You can help by improving user guides, developer documentation, or inline docs so organizers and contributors can understand how the plugin works.

No coding experience is required for many documentation issues. You will need a 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 by the repository owner. https://github.com/ account, basic Markdown familiarity, and a willingness to check the plugin or docs before writing. If an inline documentation issue involves code comments, ask for guidance before you start.

Steps

  1. Find a documentation issue. Start with GatherPress documentation issues. You can also check good first issues, but pick one only if it has a clear writing or documentation task.

  2. Check where the docs live. Compare the issue with the GatherPress documentation site, the user docs, the developer docs, and the GitHub docs folder so you know what needs to change.

  3. Claim the issue. Leave a short comment saying you would like to work on it. If the issue is unclear, ask what page or section should be updated before you start.

  4. Write the update. Fork the repository, create a branch from develop, and update the relevant Markdown file. Keep the change focused on the issue you claimed.

  5. Open a pull request. Reference the issue in your pull request, describe what you changed, and mention whether you checked the docs page, the plugin behavior, or both.

  6. Respond to review. Watch for maintainer feedback and make any requested edits.

Contribution checklist

  • Claimed one GatherPress documentation issue before starting
  • Checked the current docs page or GitHub docs file
  • Created a fork from the GatherPress develop branch
  • Submitted a focused pull request that references the issue
  • Responded to review feedback from the GatherPress team

What happens next

A GatherPress maintainer will review your pull request. If you do not hear back after a week, ask politely in #gatherpress and include the pull request link.

After your first docs pull request, you can pick another documentation issue, audit a larger section of the docs, or try a beginner-friendly code issue.

Help

Stuck? Check the getting help guide, then ask in #gatherpress.

Further reading:
GatherPress documentation
User documentation
Developer documentation
GitHub docs folder
Contributor Guide
Get Involved

Write
Beginner-friendly task

New here? Get set up with accounts, community basics, and info on badges.