From 626a6470c43a035283ccb2ac487ce343e0382d1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?sarah=20=E2=9C=88=20semark?= Date: Wed, 16 Sep 2015 19:50:15 +0100 Subject: [PATCH] Update contributor docs I've split this into two sections: submitting issues and contributing code, since those are two different actions. This fixes #615 by mentioning that both CSS and SCSS source files should be updated when submitting a PR. --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ec68829..283fc9a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,22 @@ Thanks for contributing to `_s` (Underscores) — you rock! -## _s -Before getting started, make sure your issue has not been discussed earlier. You can search for existing tickets [here](https://github.com/Automattic/_s/search). +## Submitting 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). Here are some tips to consider and to help you write a great report: * `_s` supports Internet Explorer 9 and greater, 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. In HTML5, it is common to use multiple `

` elements. -* We decided to not include translations [[#50](https://github.com/Automattic/_s/pull/50)] beyond the exisiting `_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. +* We decided not to include translations [[#50](https://github.com/Automattic/_s/pull/50)] beyond the exisiting `_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. + +## Contibuting code + +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. By contributing code to `_s`, you grant its use under the [GNU General Public License v2 (or later)](http://www.gnu.org/licenses/gpl-2.0.html).