diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 61805aafe..271b66244 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -40,7 +40,7 @@ All contributors are required to submit a click-through form to agree to the ter - Unit/integration test coverage - Proposed documentation update. - For the documentation contribution guidelines, see [DevDocs Contributing][devdocs]. + For the documentation contribution guidelines, see [DOCUMENTATION_TEMPLATE][]. 7. For large features or changes, [open an issue][issue] to discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors. 8. To report a bug, [open an issue][issue], and follow [guidelines about bugfix issues][issue reporting]. @@ -160,7 +160,7 @@ Label| Description [create issue]: https://help.github.com/articles/creating-an-issue/ [create pr]: https://help.github.com/articles/creating-a-pull-request/ [Definition of Done]: https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing_dod.html -[devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.html +[DOCUMENTATION_TEMPLATE]: https://github.com/magento/devdocs/blob/master/.github/DOCUMENTATION_TEMPLATE.md [existing issues]: https://github.com/magento/magento2-functional-testing-framework/issues?q=is%3Aopen+is%3Aissue [existing PRs]: https://github.com/magento/magento2-functional-testing-framework/pulls?q=is%3Aopen+is%3Apr [GitHub documentation]: https://help.github.com/articles/syncing-a-fork @@ -171,4 +171,4 @@ Label| Description [Magento Contributor Agreement]: http://www.magento.com/legaldocuments/mca [MFTF repository]: https://github.com/magento/magento2-functional-testing-framework [open new issue]: https://github.com/magento/magento2-functional-testing-framework/issues/new -[Travis CI]: https://travis-ci.com/magento/magento2-functional-testing-framework/pull_requests \ No newline at end of file +[Travis CI]: https://travis-ci.com/magento/magento2-functional-testing-framework/pull_requests diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md new file mode 100644 index 000000000..222ff23be --- /dev/null +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -0,0 +1,26 @@ +# How to contribute to MFTF docs + +We welcome contributions to the MFTF documentation, which is kept within the `docs/` folder in this repository. +This page describes the submitting process and serves as a template for a properly written content. +The contribution workflow is the same as submitting code. + +1. Create a branch from the `develop` branch in the [MFTF repository][]. +1. Make edits/additions/deletions as needed. Read the [Basic Template][] for tips on how to write with Markdown. +1. Submit your pull request to the `develop` branch. + +Once submitted, a member of the documentation team will review and merge it. +We will inform you if it needs any additional processing. + +The documentation in this repository is used as the source for the [MFTF documentation][]. +Any changes to the table of contents will need to be made through a separate pull request in the regular [Magento Developer documentation repository][]. + +Read more about how to [Contribute to Magento Devdocs][]. + + +[Magento Developer documentation repository]: https://github.com/magento/devdocs/blob/master/_data/toc/mftf.yml +[MFTF repository]: https://github.com/magento/magento2-functional-testing-framework +[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md +[MFTF documentation]: https://devdocs.magento.com/mftf/docs/introduction.html +[Basic Template]: https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/basic_template.html