Skip to content

Latest commit

 

History

History
44 lines (24 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

44 lines (24 loc) · 3.27 KB
Raw

Contributing

Thank you for your interest in contributing to the WordPress Hosting Team Handbook! If you're unsure of anything, please know that you're 💯 welcome to submit an Issue or Pull Request on any topic. The worst that can happen is that you'll be politely directed to the best location to ask your question or to change something in your Pull Request. All contributions are valuable, and a wall of rules could get in the way of that.

As with all WordPress projects, it is a priority to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our Code of Conduct.

All WordPress projects are licensed under the GPLv2+, and all contributions to this project will be released under the GPLv2+ license. You maintain copyright over any contribution you make, and by submitting a Pull Request, you are agreeing to release that contribution under the GPLv2+ license.

This document covers the technical details around setup and submitting your contribution to this project.

Making Edits

Pull Requests are welcome!

Please feel free to start a Pull Request (PR) by using the "Edit" button next to one of the Handbook pages, or by forking and cloning the repo (check the Forks).

All documentation is written in plain text using the Markdown format. Don't worry about any specific flavor of Markdown it's checked and cleaned before generating it to HTML.

Either way, please include a description of the purpose behind the change so that it's easy for folks to review.

Any edit requires a review from two hosting team members before being merged. Reviews can be requested in the upper right of the Pull Request form.

Assets in Pages

Assets such as images are not automatically imported into the Handbook. Because of that, assets must be included in Pull Requests within the /assets/ directory in the repo for tracking.

If you are merging a Pull Request with assets, please upload the assets to the WordPress Hosting Handbook's media library before merge, and link to the uploaded media directly.

Generating Manifest

When a new page is added to the Handbook, or if a page's title or path has been changed during a Pull Request, re-generating the manifest manually is currently required so that it can be imported to the handbook.

There's an included WP-CLI command to take care of this. To run it, from the cloned handbook repo:

  • Check if you have WP-CLI installed already by running wp or which wp
  • If you need it, install WP-CLI using the instructions from WP-CLI.org or your favorite package manager.
  • Run wp hosting-handbook gen-all.

The manifest should get created inside the repo, in /bin/handbook-manifest.json.

Changelog

  • 2022-06-07: Changelog added
  • 2020-06-02: First commit