Browse Source

Revise readme (#5717)

* Revise readme

* Update alt text

* Changed to reference most recent utility tooling

Co-authored-by: Jason Crist <jcrist@pbking.com>
Jeff Ong 3 years ago
parent
commit
05d1ac4484
1 changed files with 25 additions and 29 deletions
  1. 25 29
      README.md

+ 25 - 29
README.md

@@ -1,39 +1,44 @@
-# Automattic's Free Themes
+# Automattic Themes
 
-## Maintainers
+The development repository for themes maintained by the [Automattic Theme Team](https://themeshaper.com/about/). 
 
-These themes are maintained by the [Automattic Theme Team](https://themeshaper.com/about/).
+## What's Here
 
-## Submitting issues
+We're committed to imagining and creating the future of themes. Our latest themes are [block themes](https://developer.wordpress.org/block-editor/how-to-guides/themes/block-theme-overview/) — they depend on the latest features available in the [Gutenberg plugin](https://wordpress.org/plugins/gutenberg/). Read about our latest themes built to support full-site editing [here](https://wordpress.com/blog/2022/03/09/customize-your-entire-site-with-new-block-themes/).
 
-Before submitting your issue, make sure it has not been discussed earlier. You can search for existing tickets [here](https://github.com/Automattic/themes/search).
+<img width="1399" alt="A gallery of block themes with a variety of styles" src="https://user-images.githubusercontent.com/5375500/159330814-8f8883f3-1cd4-44a6-a404-05c8f800ac93.png">
 
-Here are some tips to consider and to help you write a great report:
+## Contributing
 
-* 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](https://translate.wordpress.com/).
+### Issues
 
-## Contributing code
+Before submitting your issue, please search for an existing or related ticket [here](https://github.com/Automattic/themes/search).
 
-Found a bug you can fix? Fantastic! Patches are always welcome. Here are a couple tips for crafting a great pull request:
+Here are some tips to consider for writing a useful report:
 
-* Include the purpose of your PR. Be explicit about the issue your PR solves.
+* Share steps for replicating the issue. 
+* Add screenshots and videos where helpful.
+* Share your environment details, including what version of WordPress and Gutenberg you're using
+
+### Code
+
+Patches and ideas in the form of code are always welcome! Here are a couple tips for crafting a great pull request:
+
+* Include the purpose of your PR. Be explicit about the idea or 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)](LICENSE).
 
-## Testing pull requests
+### Testing pull requests
 
-### Using GitHub
+#### Using GitHub
 
 1. Clone repository locally `git clone git@github.com:Automattic/themes.git`
 2. [Identify the branch](https://cloudup.com/cAy1j0D8tvH) 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
+#### Manually download
 
 1. Identify and visit [the branch](https://cloudup.com/cAy1j0D8tvH) 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`
@@ -54,7 +59,7 @@ Now when you commit changes to a file PHPCBF will attempt to fix any issues with
 
 This will also install the [WordPress-standard Prettier Configuration](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-prettier-config/) which can (optionally) be used in your IDE or command-line to format your code via (Prettier)[https://prettier.io/docs/en/editors.html].
 
-## Packaging for WordPress.org Themes Showcase
+### 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:
 
@@ -63,19 +68,10 @@ The code in this repository mirrors the code needed for the theme to function co
 
 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._
 
-## Sandbox Tools
+### Sandbox Tools
 
 If you use a sandbox to test or develop your themes you can use a couple of utilities to operate on that sandbox.
 
-- From the top-level directory, run `./sandbox.sh clean` to bring the public themes SVN repository to a clean state.  (This will only matter if your sandbox uses SVN such as how _WordPress.com_ is currently managed.)  Alternately you can trigger that as an npm script: `npm run sandbox:clean`
-
-- From the top-level directory, run `./sandbox.sh push` to push your working copy to the public themes folder of your sandbox.  Alternately you can trigger this as an npm script: `npm run sandbox:push` This command will rsync your local copy with the exception of anything in the `.sandbox-ignore` file. You should clean your sandbox before pushing any changes to it.
-NOTE: When pushing changes if your local branch is not current with /trunk you will be prompted to choose an option:
-    - FORCE where all changes you have locally will be pushed to the sandbox.  This is helpful if you are doing regression testing and want to make sure that every change is pushed to the sandbox. This option is used if --force is passed to the script.
-    - IGNORE where all of the files that were changed on the trunk since your current branch diverged will be ignored (with the exception of any files that you changed in your branch).  This is helpful during development, though it is advised that you bring your branch current with /trunk before pushing any builds. This option is used if --ignore is passed to the script.
-
-- You can automatically ignore changes on trunk adding the `--ignore` flag or by running `npm run sandbox:push:ignore`
-
-- In addition to pushing your local changes you can also WATCH for any local changes and trigger the sandbox sync by using the `npm run sandbox:watch` Any changes to your local files will trigger the rsync.  Make sure that you have executed `npm install` to ensure the needed dependencies for this are installed.
+- From the top-level directory, run `node ./theme-utils.mjs clean-sandbox` to bring the public themes GIT repository to a clean state.  (This will only matter if your sandbox uses GIT such as how _WordPress.com_ is currently managed.)  Alternately you can trigger that as an npm script: `npm run sandbox:clean`. `npm run sandbox:clean-all` will clean the entire sandbox.
 
-Note: The first time you run the `sandbox.sh` shell script you will be prompted for details about your sandbox which will be stored in a `.sandbox-config` file. Edit (or delete and be re-prompted) if details about your sandbox change.  This file will not be comitted to version controll and will not sync to your sandbox.
+- From the top-level directory, run `node ./theme-utils.mjs push-to-sandbox` to push your entire working copy to the public themes folder of your sandbox.  Alternately you can trigger this as an npm script: `npm run deploy:push:all` This command will rsync your local copy with the exception of anything in the `.sandbox-ignore` file. You should clean your sandbox before pushing any changes to it. `node ./theme-utils.mjs push-changes-to-sandbox` or `npm run deploy:push:changes` alternatively will push only files that have changed since the last deployment.