diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a8bbf9bb..a1a84483 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for contributing to `_s` (Underscores) — you rock! `_s` is maintained by the [Automattic Theme Team](https://themeshaper.com/about/). -## Submitting issues +## Reporting issues Before submitting your issue, make sure it has not been discussed earlier. You can search for existing tickets [here](https://github.com/Automattic/_s/search). @@ -15,14 +15,22 @@ Here are some tips to consider and to help you write a great report: * `_s` uses HTML5 markup. * We decided not to include translations [[#50](https://github.com/Automattic/_s/pull/50)] beyond the existing `_s.pot` file, a RTL stylesheet [[#263](https://github.com/Automattic/_s/pull/263)], or editor styles [[#225](https://github.com/Automattic/_s/pull/225)], as they are likely to change during development of an `_s` based theme. -## Contributing code +## 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. -* When submitting a change that affects CSS, please make sure that both SCSS sources and output CSS have been updated equally. -* `_s` complies with the [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/) and any PR should comply as well. +* `_s` complies with the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/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)](LICENSE).