rayelliott
/
_s
Archived
forked from mirror/_s
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
This repository has been archived on 2020-05-08. You can view files and clone it, but cannot push or open issues or pull requests.
_s/.github/CONTRIBUTING.md

3.1 KiB
Raw Blame History

Thanks for contributing to _s (Underscores) — you rock!

Maintainers

_s is maintained by the Automattic Theme Team.

Reporting 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:

  • _s supports Microsoft Internet Explorer 11 and Edge, as well as the latest two versions of all other major browsers.
  • _s is backwards compatible with the two versions prior to the current stable version of WordPress.
  • _s uses HTML5 markup.
  • We decided not to include translations [#50] beyond the existing _s.pot file, a RTL stylesheet [#263], or editor styles [#225], as they are likely to change during development of an _s based theme.

Sending a Pull Request

Found a bug you can fix? Fantastic! Patches are always welcome. Here's a few 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.
  • _s complies with the WordPress Coding Standards and any PR should comply as well.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repo and create your branch from master.
  2. Run npm install and composer install.
  3. When submitting a change that affects SCSS sources, please make sure there is no linting errors using npm run lint:scss, then generate the css files using npm run compile:css and npm run compile:rtl.
  4. When submitting a change that affects PHP files, please make sure there is no syntax or linting errors by running composer lint:php then composer lint:wpcs.
  5. When submitting a change that affects JS files, please make sure there is no linting errors by running npm run lint:js.
  6. When submitting a change that affects text strings, make sure to regenerate the POT file by running composer make-pot.

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

Underscores.me

If your issue is specific to the Underscores.me website, the Underscores.me GitHub repo is the right place for you.

The preferred method of generating a new theme based on _s is the Underscores.me website. If you have an alternative method, such as a shell script, write a blog post about it or host it in a separate repo -- and make sure to mention @underscoresme in your tweets!

Want to have your avatar listed as one of the _s contributors here? Just make sure you have an email address added to both GitHub and your local Git installation.