Skip to content

Commit 57f2eaa

Browse files
committed
MQE-1796: Magento Git vs Composer and MFTF
Addressed review comments
1 parent e345f05 commit 57f2eaa

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/guides/git-vs-composer-install.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
If you are planning on contributing a PR to the Magento 2 codebase, you can download Magento 2 from GitHub. Contribution to the codebase is done using the 'fork and pull' model where contributors maintain their own fork of the repo. This repo is then used to submit a pull request to the base repo.
77

8-
Install guide: [GitHub Installation](https://devdocs.magento.com/mftf/docs/getting-started.html)
8+
Install guide: [GitHub Installation](https://devdocs.magento.com/guides/v2.3/install-gde/prereq/dev_install.html)
9+
910

1011
###Composer based Installation
1112

@@ -16,6 +17,13 @@ All Magento modules and their MFTF tests are put under `<vendor>` directory for
1617
Install guide: [Composer based Installation](https://devdocs.magento.com/guides/v2.3/install-gde/composer.html)
1718

1819

20+
### MFTF Installation
21+
22+
After installing your Magento project in either of the above ways, the composer dependency `magento/magento2-functional-testing-framework` allows you to download and install MFTF. MFTF will be embedded in your Magento 2 installation and will cover your project with functional tests.
23+
24+
If you want to contribute a PR into MFTF codebase, you will need to install MFTF in the [Standalone] mode.
25+
26+
1927
###Managing modules - Composer vs GitHub
2028

2129
####Via GitHub:
@@ -55,18 +63,22 @@ The file structure under both paths is the same as below:
5563
└── ...
5664
```
5765

66+
5867
###How ModuleResolver reads modules
5968

6069
In either of the installations, all tests and test data are read and merged by MFTF's ModuleResolver in the order indicated below:
6170

6271
1. `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`
6372
2. `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`
6473

74+
6575
###Conclusion
6676

6777
There are no differences from MFTF's perspective between having the test artifacts in `app/code` or in `/vendor` as it reads artifacts from both paths. It works the same. Composer based install may benefit teams when there's a need to match file systems in dev and production.
6878

6979
If you are a contributing developer with an understanding of Git and Composer commands, you can choose the GitHub installation method instead.
7080

7181

82+
<!-- Link definitions -->
7283

84+
[Standalone]: ../getting-started.html#set-up-a-standalone-mftf

0 commit comments

Comments
 (0)