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

43 lines
3.1 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
clarify who maintains _s and standardize returns in CONTRIBUTING.md
2017-02-09 16:41:27 +00:00
## Maintainers
`_s` is maintained by the [Automattic Theme Team](https://themeshaper.com/about/).
Add instruction to run CLI tools in CONTRIBUTING.md
2020-04-17 20:47:35 +00:00
## Reporting issues
clarify who maintains _s and standardize returns in CONTRIBUTING.md
2017-02-09 16:41:27 +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
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.
Fix typo line no 11, it says _s -based theme. I think - before based is not necessary there
2016-08-17 01:44:39 +00:00
* 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.
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
Add instruction to run CLI tools in CONTRIBUTING.md
2020-04-17 20:47:35 +00:00
## Sending a Pull Request
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
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.
Add instruction to run CLI tools in CONTRIBUTING.md
2020-04-17 20:47:35 +00:00
* `_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`.
_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
add v2 or later
2016-07-15 14:59:29 +00:00
By contributing code to `_s`, you grant its use under the [GNU General Public License v2 (or later)](LICENSE).
_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
## Underscores.me
clarify who maintains _s and standardize returns in CONTRIBUTING.md
2017-02-09 16:41:27 +00:00
Change links http:// to https:// All necessary links checked and updated to https, some remain as http as those aren't using secured protocol yet
2017-10-10 17:29:36 +00:00
If your issue is specific to the [Underscores.me](https://underscores.me) website, the [Underscores.me GitHub repo](https://github.com/Automattic/underscores.me) is the right place for you.
_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
Change links http:// to https:// All necessary links checked and updated to https, some remain as http as those aren't using secured protocol yet
2017-10-10 17:29:36 +00:00
The preferred method of generating a new theme based on `_s` is the [Underscores.me](https://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!
_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
Change links http:// to https:// All necessary links checked and updated to https, some remain as http as those aren't using secured protocol yet
2017-10-10 17:29:36 +00:00
Want to have your avatar listed as one of the `_s` contributors [here](https://underscores.me/#contribute)? Just make sure you have an email address added to both GitHub and your local Git installation.