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/CONTRIBUTING.md

29 lines
2.2 KiB
Markdown
Raw Normal View History

_s: First version of contributing guidelines. This might change in the future, based on our experiences, but should be a good first draft of helpful and friendly guidelines for contributing. Props @bungeshea. Fixes #381.
2014-04-15 18:45:02 +00:00
Thanks for contributing to `_s` (Underscores) — you rock!
Added contributing guidelines https://github.com/blog/1184-contributing-guidelines
2014-01-13 00:29:01 +00:00
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.
2015-09-16 18:50:15 +00:00
## 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).
Added contributing guidelines https://github.com/blog/1184-contributing-guidelines
2014-01-13 00:29:01 +00:00
_s: First version of contributing guidelines. This might change in the future, based on our experiences, but should be a good first draft of helpful and friendly guidelines for contributing. Props @bungeshea. Fixes #381.
2014-04-15 18:45:02 +00:00
Here are some tips to consider and to help you write a great report:
Update browser support documentation
2016-01-21 18:56:08 +00:00
* `_s` supports Microsoft Internet Explorer 11 and Edge, as well as the latest two versions of all other major browsers.
_s: First version of contributing guidelines. This might change in the future, based on our experiences, but should be a good first draft of helpful and friendly guidelines for contributing. Props @bungeshea. Fixes #381.
2014-04-15 18:45:02 +00:00
* `_s` is backwards compatible with the two versions prior to the current stable version of WordPress.
remove note on HTML5 and H1s following #776
2015-12-08 15:31:58 +00:00
* `_s` uses HTML5 markup.
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.
2015-09-16 18:50:15 +00:00
* 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.
_s: First version of contributing guidelines. This might change in the future, based on our experiences, but should be a good first draft of helpful and friendly guidelines for contributing. Props @bungeshea. Fixes #381.
2014-04-15 18:45:02 +00:00
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).
## Underscores.me
If your issue is specific to the [Underscores.me](http://underscores.me) website, the [Underscores.me GitHub repo](https://github.com/Automattic/underscores.me) is the right place for you.
The preferred method of generating a new theme based on `_s` is the [Underscores.me](http://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](https://twitter.com/underscoresme) in your tweets!
Want to have your avatar listed as one of the `_s` contributors [here](http://underscores.me/#contribute)? Just make sure you have an email address added to both GitHub and your local Git installation.