|
1 | | -# Magento Functional Testing Framework |
| 1 | +# Magento Functional Testing Framework (MFTF) |
2 | 2 |
|
3 | 3 | [](https://travis-ci.org/magento/magento2-functional-testing-framework) |
4 | 4 |
|
5 | 5 | [](https://coveralls.io/github/magento/magento2-functional-testing-framework) |
6 | 6 |
|
7 | 7 | ---- |
8 | 8 |
|
9 | | -## System Requirements |
10 | | -[Magento Functional Testing Framework system requirements](http://devdocs.magento.com/guides/v2.2/magento-functional-testing-framework/getting-started.html#prepare-environment) |
11 | | - |
12 | 9 | ## Installation |
13 | | -To install the Magento Functional Testing Framework, see [Getting Started](http://devdocs.magento.com/guides/v2.2/magento-functional-testing-framework/getting-started.html) |
14 | | - |
15 | | -## Contributing |
16 | | -Contributions can take the form of new components or features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes, optimizations, or just good suggestions. |
17 | 10 |
|
18 | | -To learn about how to make a contribution, click [here][1]. |
| 11 | +For the installation guidelines and system requirements, read [Getting Started](https://devdocs.magento.com/mftf/2.3/getting-started.html). |
19 | 12 |
|
20 | | -To open an issue, click [here][2]. |
| 13 | +## Contributing |
21 | 14 |
|
22 | | -To suggest documentation improvements, click [here][3]. |
| 15 | +We would appreciate your contributions to new components or new features, changes to the existing features, tests, documentation, specifications, bug fixes, optimizations, or just good suggestions. |
| 16 | +Report about an issue or request features opening a GitHub issue. |
| 17 | +Learn more about contributing in our [Contribution Guidelines](https://devdocs.magento.com/mftf/2.3/contribution-guidelines.html). |
23 | 18 |
|
24 | | -[1]: <http://devdocs.magento.com/guides/v2.2/magento-functional-testing-framework/contribution-guidelines.html> |
25 | | -[2]: <https://github.com/magento/magento2-functional-testing-framework/issues> |
26 | | -[3]: <http://devdocs.magento.com> |
| 19 | +If you want to participate in the documentation work, see [DevDocs Contributing](https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md). |
27 | 20 |
|
28 | 21 | ### Labels applied by the MFTF team |
29 | 22 |
|
30 | | -Refer to the tables with descriptions of each label below. These labels are applied by the MFTF development team to community contributed issues and pull requests, to communicate status, impact, or which team is working on it. |
| 23 | +Refer to the tables with descriptions of each label below. |
| 24 | +These labels are applied by the MFTF development team to community contributed issues and pull requests, to communicate status, impact, or which team is working on it. |
31 | 25 |
|
32 | 26 | ### Pull Request Status |
33 | 27 |
|
34 | | -Label| Description |
35 | | ----|--- |
36 | | -**accept**| The pull request has been accepted and will be merged into mainline code. |
37 | | -**reject**| The pull request has been rejected and will not be merged into mainline code. Possible reasons can include but are not limited to: issue has already been fixed in another code contribution, or there is an issue with the code contribution. |
38 | | -**needsUpdate**| The Magento Team needs additional information from the reporter to properly prioritize and process the pull request. |
| 28 | +| Label | Description | |
| 29 | +| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 30 | +| **accept** | The pull request has been accepted and will be merged into mainline code. | |
| 31 | +| **reject** | The pull request has been rejected and will not be merged into mainline code. Possible reasons can include but are not limited to: issue has already been fixed in another code contribution, or there is an issue with the code contribution. | |
| 32 | +| **needsUpdate** | The Magento Team needs additional information from the reporter to properly prioritize and process the pull request. | |
39 | 33 |
|
40 | 34 | ### Issue Resolution Status |
41 | 35 |
|
42 | | -Label| Description |
43 | | ----|--- |
44 | | -**acknowledged**| The Magento Team has validated the issue and an internal ticket has been created. |
45 | | -**needsUpdate**| The Magento Team needs additional information from the reporter to properly prioritize and process the issue or pull request. |
46 | | -**cannot reproduce**| The Magento Team has not confirmed that this issue contains the minimum required information to reproduce. |
47 | | -**non-issue**| The Magento Team has not recognised any issue according to provided information. |
| 36 | +| Label | Description | |
| 37 | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------- | |
| 38 | +| **acknowledged** | The Magento Team has validated the issue and an internal ticket has been created. | |
| 39 | +| **needsUpdate** | The Magento Team needs additional information from the reporter to properly prioritize and process the issue or pull request. | |
| 40 | +| **cannot reproduce** | The Magento Team has not confirmed that this issue contains the minimum required information to reproduce. | |
| 41 | +| **non-issue** | The Magento Team has not recognized any issue according to provided information. | |
48 | 42 |
|
49 | 43 | ### Domains Impacted |
50 | 44 |
|
51 | | -Label| Description |
52 | | ----|--- |
53 | | -**PROD**| Affects the Product team (mostly feature requests or business logic change). |
54 | | -**DOC**| Affects Documentation domain. |
55 | | -**TECH**| Affects Architect Group (mostly to make decisions around technology changes). |
| 45 | +| Label | Description | |
| 46 | +| -------- | ----------------------------------------------------------------------------- | |
| 47 | +| **PROD** | Affects the Product team (mostly feature requests or business logic change). | |
| 48 | +| **DOC** | Affects Documentation domain. | |
| 49 | +| **TECH** | Affects Architect Group (mostly to make decisions around technology changes). | |
56 | 50 |
|
57 | 51 | ### Type |
58 | 52 |
|
59 | | -Label| Description |
60 | | ----|--- |
61 | | -**bugfix**| The issue or pull request relates to bug fixing. |
62 | | -**enhancement**| The issue or pull request that raises the MFTF to a higher degree (for example new features, optimization, refactoring, etc). |
| 53 | +| Label | Description | |
| 54 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------- | |
| 55 | +| **bugfix** | The issue or pull request relates to bug fixing. | |
| 56 | +| **enhancement** | The issue or pull request that raises the MFTF to a higher degree (for example new features, optimization, refactoring, etc). | |
63 | 57 |
|
64 | 58 | ## Reporting security issues |
65 | 59 |
|
66 | | -To report security vulnerabilities in Magento software or web sites, please e-mail <a href="mailto:security@magento.com">security@magento.com</a>. Please do not report security issues using GitHub. Be sure to encrypt your e-mail with our <a href="https://info2.magento.com/rs/magentoenterprise/images/security_at_magento.asc">encryption key</a> if it includes sensitive information. Learn more about reporting security issues <a href="https://magento.com/security/reporting-magento-security-issue">here</a>. |
| 60 | +To report security vulnerabilities and other security issues in the Magento software or web sites, send an email with the report at [security@magento.com](mailto:security@magento.com). |
| 61 | +Do not report security issues using GitHub. |
| 62 | +Be sure to encrypt your e-mail with our [encryption key](https://info2.magento.com/rs/magentoenterprise/images/security_at_magento.asc) if it includes sensitive information. |
| 63 | +Learn more about reporting security issues [here](https://magento.com/security/reporting-magento-security-issue). |
67 | 64 |
|
68 | | -Stay up-to-date on the latest security news and patches for Magento by signing up for <a href="https://magento.com/security/sign-up">Security Alert Notifications</a>. |
| 65 | +Stay up-to-date on the latest security news and patches for Magento by signing up for [Security Alert Notifications](https://magento.com/security/sign-up). |
69 | 66 |
|
70 | 67 | ## License |
71 | 68 |
|
72 | | -Each Magento source file included in this distribution is licensed under AGPL 3.0 |
| 69 | +Each Magento source file included in this distribution is licensed under AGPL 3.0. |
73 | 70 |
|
74 | | -Please see LICENSE_AGPL3.txt for the full text of the AGPL 3.0 license or contact license@magentocommerce.com for a copy. |
| 71 | +See the license [here](LICENSE_AGPL3.txt) or contact [license@magentocommerce.com](mailto:license@magentocommerce.com) for a copy. |
0 commit comments