beenull/themes-wordpress
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
themes-wordpress/README.md
Jeff Ong 916a0c6e04
Clarify packaging dotorg instructions.
2020-11-04 12:58:38 -05:00

3.3 KiB
Raw Blame History

Automattic's Free Themes

Maintainers

These themes are maintained by the Automattic Theme Team.

Submitting issues

Before submitting your issue, make sure it has not been discussed earlier. You can search for existing tickets here.

Here are some tips to consider and to help you write a great report:

  • Themes support Microsoft Internet Explorer 11 and Edge, as well as the latest two versions of all other major browsers.
  • Themes are backwards compatible with the two versions prior to the current stable version of WordPress.
  • Themes use HTML5 markup.
  • Translation files should not be included in PRs, as these are handled by WordPress.com. See here for information on contributing to i18n efforts on WordPress.com.

Contributing code

Found a bug you can fix? Fantastic! Patches are always welcome. Here are a couple tips for crafting a great pull request:

  • Include the purpose of your PR. Be explicit about the issue your PR solves.
  • Reference any existing issues that relate to your PR. This allows everyone to easily see all related discussions.

By contributing code to our free themes, you grant its use under the GNU General Public License v2 (or later).

Testing pull requests

Using GitHub

  1. Clone repository locally git clone git@github.com:Automattic/themes.git
  2. Identify the branch of the pull request, e.g. update/#1889
  3. Check out featured branch of pull request, e.g. git checkout update/#1889
  4. Symlink or copy affected theme OR zip affected theme and import into WordPress site

Manually download

  1. Identify and visit the branch of the pull request.
  2. Change the /tree/ part of the branch's URL to archive, and add a .zip to the end to download a zip of the branch. e.g. https://github.com/Automattic/themes/tree/update/%231889 would become https://github.com/Automattic/themes/archive/update/%231889.zip
  3. Unzip the zipped featured branch
  4. Zip affected theme and import into WordPress site

Note: In case the affected theme already exists on the WordPress site, it needs to be deleted before the theme zip file gets uploaded.

Coding Standards

Themes code should adhere to the WordPress coding standards. This repo contains a pre-commit hook which enables you to detect and fix code that doesn't follow the standards.

To set this uo follow these instructions:

  1. Run npm i in the root of the repo.
  2. Run composer install

Now when you commit changes to a file PHPCBF will attempt to fix any issues with the file.

Packaging for WordPress.org Themes Showcase

The code in this repository mirrors the code needed for the theme to function correctly on WordPress.com. To prepare a theme.zip that passes the WordPress.org theme review automated test, do the following:

  • From the top-level directory, run ./package-dotorg.sh [theme-slug]
  • View the generated zip in the respective theme's sub-directory

Note that this script rebuilds the theme to strip it of .com-specific functionality, and discards any changes via git after doing so. Make sure you have committed any working changes before running this script.