You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use the [fork] & [pull] model to contribute to the Magento Functional Testing Framework (MFTF) code base.
15
15
This contribution model has contributors maintaining their own copy of the forked code base (which can be easily synced with the main copy).
@@ -31,16 +31,18 @@ All contributors are required to submit a click-through form to agree to the ter
31
31
32
32
1. Contributions must adhere to [Magento coding standards].
33
33
2. Refer to the Magento development team’s [Definition of Done].
34
-
We use these guidelines internally to ensure that we deliver well-tested, well-documented, solid code, and we encourage you to as well!
34
+
We use these guidelines internally to ensure that we deliver well-tested, well-documented, solid code, and we encourage you to as well!
35
35
3. Pull requests (PRs) must be accompanied by a meaningful description of their purpose.
36
-
Comprehensive descriptions increase the chances that a pull request is merged quickly and without additional clarification requests.
36
+
Comprehensive descriptions increase the chances that a pull request is merged quickly and without additional clarification requests.
37
37
4. Commits must be accompanied by meaningful commit messages.
38
38
5. PRs that include bug fixing must be accompanied by a step-by-step description of how to reproduce the bug.
39
39
6. PRs that include new logic or new features must be submitted along with:
40
-
* Unit/integration test coverage
41
-
* Proposed [documentation update]. Documentation contributions can be submitted [here][devdocs].
40
+
41
+
- Unit/integration test coverage
42
+
- Proposed documentation update.
43
+
For the documentation contribution guidelines, see [DevDocs Contributing][devdocs].
42
44
7. For large features or changes, [open an issue][issue] to discuss first.
43
-
This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
45
+
This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
44
46
8. To report a bug, [open an issue][issue], and follow [guidelines about bugfix issues][issue reporting].
45
47
9. All automated tests must pass successfully (all builds on [Travis CI] must be green).
46
48
@@ -59,17 +61,15 @@ Learn more in the [Fork a repo][github fork] GitHub article.
59
61
As community and Magento writers’ changes are merged to the repository, your fork becomes outdated and pull requests might result in conflicts.
60
62
To see if your fork is outdated, open the fork page in GitHub and if at the top displays the following message:
61
63
62
-
```
63
-
This branch is NUMBER commits behind magento:develop.
64
-
```
64
+
__This branch is NUMBER commits behind magento:develop.__
65
65
66
66
It means your fork must be updated.
67
-
67
+
68
68
There are two ways to update your fork.
69
69
The typical way is discussed in the [Syncing a fork][github sync fork] GitHub article.
70
70
Make sure to update from the correct branch!
71
71
72
-
The othger way is to create a reverse pull request from the original repository.
72
+
The other way is to create a reverse pull request from the original repository.
73
73
Though this method has the downside of inserting unnecessary information into fork commit history.
74
74
75
75
1. In your fork, click **New pull request**.
@@ -94,8 +94,8 @@ To create a pull request do the following:
94
94
Learn more in the [Creating a pull request][create pr] GitHub article.
95
95
96
96
After submitting your PR, you can head over to the repository’s [Pull Requests panel][existing PRs] to see your PR along with the others.
97
-
Your PR undergoes automated testing, and if it passes, the core team considers it for inclusion in the Magento Functional Testing Framework codebase.
98
-
If some tests fail, make the corresponding corrections in your code.
97
+
Your PR undergoes automated testing, and if it passes, the core team considers it for inclusion in the Magento Functional Testing Framework codebase.
98
+
If some tests fail, make the corresponding corrections in your code.
99
99
100
100
## Report an issue
101
101
@@ -110,8 +110,8 @@ Before creating an issue, do the following:
110
110
To add an issue:
111
111
112
112
1.[Open a new issue][open new issue]
113
-
3. Fill in the **Title** and issue description
114
-
4. Click **Submit new issue**
113
+
2. Fill in the **Title** and issue description
114
+
3. Click **Submit new issue**
115
115
116
116
Learn more in the [Creating an issue][create issue] GitHub article.
117
117
@@ -124,7 +124,7 @@ The labels reflect the status, impact, or which team is working on it.
124
124
125
125
Label| Description
126
126
---|---
127
-
**accept**| The pull request has been accepted to be merged into mainline code.
127
+
**accept**| The pull request has been accepted to be merged into mainline code.
128
128
**reject**| The pull request has been rejected. The most common cases are when the issue has already been fixed in another code contribution, or there is an issue with the code contribution.
129
129
**needsUpdate**| We need more information from the PR author to properly prioritize and process the pull request.
130
130
@@ -134,7 +134,7 @@ Label| Description
134
134
---|---
135
135
**acknowledged**| We validated the issue and created an internal ticket.
136
136
**needsUpdate**| We need more information from the PR author to properly prioritize and process the issue.
137
-
**cannot reproduce**| We do not have enough details from the issue description to reproduce the issue.
137
+
**cannot reproduce**| We do not have enough details from the issue description to reproduce the issue.
138
138
**non-issue**| We don't think that this is an issue according to the provided information.
139
139
140
140
### Domains impacted
@@ -152,7 +152,6 @@ Label| Description
152
152
**bugfix**| The issue or pull request is about fixing a bug.
153
153
**enhancement**| The issue or pull request that makes the MFTF even more awesome (for example new features, optimization, refactoring, etc).
0 commit comments