Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/.github/CONTRIBUTING.md

16 lines
616 B
Markdown
Raw Normal View History

Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
# Contributing
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
Thanks for your interest in contributing to WooCommerce Blocks!
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
If you wish to contribute code, to get started we recommend first reading our [Getting Started Guide](./docs/contributors/getting-started.md).
Add "contributor" docs for developer tools, release processes (https://github.com/woocommerce/woocommerce-blocks/pull/504) * Docs: Add docs for npm scripts and the release process * Update readme to reflect project status * Add install instructions * Add a link to a previous PR for an example
2019-03-22 14:40:55 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
All other documentation for contributors can be found [in the docs directory](./docs/readme.md).
Document release process (https://github.com/woocommerce/woocommerce-blocks/pull/1614) * draft release process! * ensure info in CONTRIBUTING is in release doc, remove section & add link * fix link to release doc * tweaks / typos / formatting after re-read * tweak mia/follow up section title to more standard @todo * add getting started docs for repo/dev tooling (required for releasing!) * add intro sentence + link to required node versions + fix some grammar errors, heading level * tweaks based on Timmy feedback: - link to a real changelog commit - add git pull to unambiguously illustrate "get on tip of branch" - recommend multiple testers + sanity check => confidence check * mention jetpack-autoloader * reinstate "updating specific file on WPORG" section * flesh out "release to wporg" so tools are more transparent + + add steps for testing/validating WPORG release * clarify major / minor / patch process differences + + roughly define versions + mention Zenhub (tbc) * clarification: cherry picking is patch releases only + + clarify readme update outcome * tweaks & typos after reading start=>finish * clarify versions info + tidy links in WPORG validate section * tweaks & typos from Aljullu feedback * flesh out pre-release testing steps: - test oldest supported WP - test existing blocks content / validation errors - ALL of the testing steps are recommended :)
2020-01-22 19:48:35 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
## Guidelines
Document release process (https://github.com/woocommerce/woocommerce-blocks/pull/1614) * draft release process! * ensure info in CONTRIBUTING is in release doc, remove section & add link * fix link to release doc * tweaks / typos / formatting after re-read * tweak mia/follow up section title to more standard @todo * add getting started docs for repo/dev tooling (required for releasing!) * add intro sentence + link to required node versions + fix some grammar errors, heading level * tweaks based on Timmy feedback: - link to a real changelog commit - add git pull to unambiguously illustrate "get on tip of branch" - recommend multiple testers + sanity check => confidence check * mention jetpack-autoloader * reinstate "updating specific file on WPORG" section * flesh out "release to wporg" so tools are more transparent + + add steps for testing/validating WPORG release * clarify major / minor / patch process differences + + roughly define versions + mention Zenhub (tbc) * clarification: cherry picking is patch releases only + + clarify readme update outcome * tweaks & typos after reading start=>finish * clarify versions info + tidy links in WPORG validate section * tweaks & typos from Aljullu feedback * flesh out pre-release testing steps: - test oldest supported WP - test existing blocks content / validation errors - ALL of the testing steps are recommended :)
2020-01-22 19:48:35 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
Like the WooCommerce project, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [Code of Conduct](./.github/CODE_OF_CONDUCT.md).
Document release process (https://github.com/woocommerce/woocommerce-blocks/pull/1614) * draft release process! * ensure info in CONTRIBUTING is in release doc, remove section & add link * fix link to release doc * tweaks / typos / formatting after re-read * tweak mia/follow up section title to more standard @todo * add getting started docs for repo/dev tooling (required for releasing!) * add intro sentence + link to required node versions + fix some grammar errors, heading level * tweaks based on Timmy feedback: - link to a real changelog commit - add git pull to unambiguously illustrate "get on tip of branch" - recommend multiple testers + sanity check => confidence check * mention jetpack-autoloader * reinstate "updating specific file on WPORG" section * flesh out "release to wporg" so tools are more transparent + + add steps for testing/validating WPORG release * clarify major / minor / patch process differences + + roughly define versions + mention Zenhub (tbc) * clarification: cherry picking is patch releases only + + clarify readme update outcome * tweaks & typos after reading start=>finish * clarify versions info + tidy links in WPORG validate section * tweaks & typos from Aljullu feedback * flesh out pre-release testing steps: - test oldest supported WP - test existing blocks content / validation errors - ALL of the testing steps are recommended :)
2020-01-22 19:48:35 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
## Reporting Security Issues
Document release process (https://github.com/woocommerce/woocommerce-blocks/pull/1614) * draft release process! * ensure info in CONTRIBUTING is in release doc, remove section & add link * fix link to release doc * tweaks / typos / formatting after re-read * tweak mia/follow up section title to more standard @todo * add getting started docs for repo/dev tooling (required for releasing!) * add intro sentence + link to required node versions + fix some grammar errors, heading level * tweaks based on Timmy feedback: - link to a real changelog commit - add git pull to unambiguously illustrate "get on tip of branch" - recommend multiple testers + sanity check => confidence check * mention jetpack-autoloader * reinstate "updating specific file on WPORG" section * flesh out "release to wporg" so tools are more transparent + + add steps for testing/validating WPORG release * clarify major / minor / patch process differences + + roughly define versions + mention Zenhub (tbc) * clarification: cherry picking is patch releases only + + clarify readme update outcome * tweaks & typos after reading start=>finish * clarify versions info + tidy links in WPORG validate section * tweaks & typos from Aljullu feedback * flesh out pre-release testing steps: - test oldest supported WP - test existing blocks content / validation errors - ALL of the testing steps are recommended :)
2020-01-22 19:48:35 +00:00
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
Please see [SECURITY.md](./.github/SECURITY.md).