Skip to content

Commit 49d318e

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

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
#Git vs Composer Installation of Magento with MFTF
1+
# Git vs Composer Installation of Magento with MFTF
22

33

4-
###GitHub Installation
4+
### GitHub Installation
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

88
Install guide: [GitHub Installation](https://devdocs.magento.com/guides/v2.3/install-gde/prereq/dev_install.html)
99

1010

11-
###Composer based Installation
11+
### Composer based Installation
1212

1313
Composer install downloads released packages of Magento 2 from the composer repo [https://repo.magento.com](https://repo.magento.com).
1414

@@ -24,13 +24,13 @@ After installing your Magento project in either of the above ways, the composer
2424
If you want to contribute a PR into MFTF codebase, you will need to install MFTF in the [Standalone] mode.
2525

2626

27-
###Managing modules - Composer vs GitHub
27+
### Managing modules - Composer vs GitHub
2828

29-
####Via GitHub:
29+
#### Via GitHub:
3030

3131
Cloning Magento 2 git repository is a way of installing when you don't have to worry frequently about matching the codebase with production. Your version control system generally holds and manages your `app/code` folder and you can do manual ad-hoc development here.
3232

33-
####Via composer:
33+
#### Via composer:
3434

3535
Magento 2 advocates the use of composer for managing modules. When you install a module through composer, it is added to `vendor/<vendor-name>/<module>`
3636

@@ -39,11 +39,11 @@ If you are developing your own module or adding MFTF tests to the module, you sh
3939
If you want to distribute the module and its tests, you can initialize a git repo and create a [composer package](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/package/package_module.html). In this way others will be able to download and install your module and access your tests as a composer package, in their `<vendor>` folder.
4040

4141

42-
###MFTF test artifacts location
42+
### MFTF test artifacts location
4343

44-
- For GitHub installation, MFTF test artifacts are located at `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to create new tests or maintain existing ones.
44+
- For GitHub installation, MFTF test materials are located at `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to create new tests or maintain existing ones.
4545

46-
- For Composer based installation, MFTF test artifacts are located at `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to run tests fetched by Composer.
46+
- For Composer based installation, MFTF test materials are located at `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to run tests fetched by Composer.
4747

4848
The file structure under both paths is the same as below:
4949

@@ -64,17 +64,17 @@ The file structure under both paths is the same as below:
6464
```
6565

6666

67-
###How ModuleResolver reads modules
67+
### How ModuleResolver reads modules
6868

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

7171
1. `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`
7272
2. `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`
7373

7474

75-
###Conclusion
75+
### Conclusion
7676

77-
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.
77+
There are no differences from MFTF's perspective between having the test materials 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.
7878

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

0 commit comments

Comments
 (0)