Skip to content

Commit f72eee0

Browse files
authored
Merge branch 'develop' into MQE-1541
2 parents 5e90be5 + 291bad3 commit f72eee0

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ All contributors are required to submit a click-through form to agree to the ter
4040

4141
- Unit/integration test coverage
4242
- Proposed documentation update.
43-
For the documentation contribution guidelines, see [DevDocs Contributing][devdocs].
43+
For the documentation contribution guidelines, see [DOCUMENTATION_TEMPLATE][].
4444
7. For large features or changes, [open an issue][issue] to discuss first.
4545
This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
4646
8. To report a bug, [open an issue][issue], and follow [guidelines about bugfix issues][issue reporting].
@@ -160,7 +160,7 @@ Label| Description
160160
[create issue]: https://help.github.com/articles/creating-an-issue/
161161
[create pr]: https://help.github.com/articles/creating-a-pull-request/
162162
[Definition of Done]: https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing_dod.html
163-
[devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.html
163+
[DOCUMENTATION_TEMPLATE]: https://github.com/magento/devdocs/blob/master/.github/DOCUMENTATION_TEMPLATE.md
164164
[existing issues]: https://github.com/magento/magento2-functional-testing-framework/issues?q=is%3Aopen+is%3Aissue
165165
[existing PRs]: https://github.com/magento/magento2-functional-testing-framework/pulls?q=is%3Aopen+is%3Apr
166166
[GitHub documentation]: https://help.github.com/articles/syncing-a-fork
@@ -171,4 +171,4 @@ Label| Description
171171
[Magento Contributor Agreement]: http://www.magento.com/legaldocuments/mca
172172
[MFTF repository]: https://github.com/magento/magento2-functional-testing-framework
173173
[open new issue]: https://github.com/magento/magento2-functional-testing-framework/issues/new
174-
[Travis CI]: https://travis-ci.com/magento/magento2-functional-testing-framework/pull_requests
174+
[Travis CI]: https://travis-ci.com/magento/magento2-functional-testing-framework/pull_requests

.github/DOCUMENTATION_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# How to contribute to MFTF docs
2+
3+
We welcome contributions to the MFTF documentation, which is kept within the `docs/` folder in this repository.
4+
This page describes the submitting process and serves as a template for a properly written content.
5+
The contribution workflow is the same as submitting code.
6+
7+
1. Create a branch from the `develop` branch in the [MFTF repository][].
8+
1. Make edits/additions/deletions as needed. Read the [Basic Template][] for tips on how to write with Markdown.
9+
1. Submit your pull request to the `develop` branch.
10+
11+
Once submitted, a member of the documentation team will review and merge it.
12+
We will inform you if it needs any additional processing.
13+
14+
The documentation in this repository is used as the source for the [MFTF documentation][].
15+
Any changes to the table of contents will need to be made through a separate pull request in the regular [Magento Developer documentation repository][].
16+
17+
Read more about how to [Contribute to Magento Devdocs][].
18+
19+
<!-- For readability, we abstract the link URLS to the bottom of the page. The extra set of square brackets denotes it is a link, rather than plain brackets. >
20+
21+
<!-- Link Definitions -->
22+
[Magento Developer documentation repository]: https://github.com/magento/devdocs/blob/master/_data/toc/mftf.yml
23+
[MFTF repository]: https://github.com/magento/magento2-functional-testing-framework
24+
[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
25+
[MFTF documentation]: https://devdocs.magento.com/mftf/docs/introduction.html
26+
[Basic Template]: https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/basic_template.html

0 commit comments

Comments
 (0)