CONTRIBUTING.md 9.2 KB
Contribution Guidelines for the Magento Functional Testing Framework
Use the fork & pull model to contribute to the Magento Functional Testing Framework (MFTF) code base. This contribution model has contributors maintaining their own copy of the forked code base (which can be easily synced with the main copy). The forked repository is then used to submit a request to the base repository to pull a set of changes (pull request).
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.
The MFTF development team reviews all issues and contributions submitted by the community of developers in a "first-in, first-out" basis. During the review we might require clarifications from the contributor. If there is no response from the contributor for two weeks, the issue is closed.
Often when the MFTF team works on reviewing the suggested changes, we will add a label to the issue to indicate to our internal team certain information, like status or who is working the issue. If you’re ever curious what the different labels mean, see the table below for an explanation of each one.
Refer to Magento Contributor Agreement for detailed information about the License Agreement. All contributors are required to submit a click-through form to agree to the terms.
Contribution requirements
- Contributions must adhere to Magento coding standards.
- Refer to the Magento development team’s Definition of Done. We use these guidelines internally to ensure that we deliver well-tested, well-documented, solid code, and we encourage you to as well!
- Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances that a pull request is merged quickly and without additional clarification requests.
- Commits must be accompanied by meaningful commit messages.
- PRs that include bug fixing must be accompanied by a step-by-step description of how to reproduce the bug.
PRs that include new logic or new features must be submitted along with:
- Unit/integration test coverage
- Proposed documentation update. For the documentation contribution guidelines, see DevDocs Contributing.
For large features or changes, open an issue to discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
To report a bug, open an issue, and follow guidelines about bugfix issues.
All automated tests must pass successfully (all builds on Travis CI must be green).
Fork a repository
To fork a repository on Github, do the following:
- Navigate to the MFTF repository.
- Click Fork at the top right.
- Clone the repo into your development environment and start playing.
Learn more in the Fork a repo GitHub article.
Update the fork with the latest changes
As community and Magento writers’ changes are merged to the repository, your fork becomes outdated and pull requests might result in conflicts. To see if your fork is outdated, open the fork page in GitHub and if at the top displays the following message:
This branch is NUMBER commits behind magento:develop.
It means your fork must be updated.
There are two ways to update your fork. The typical way is discussed in the Syncing a fork GitHub article. Make sure to update from the correct branch!
The other way is to create a reverse pull request from the original repository. Though this method has the downside of inserting unnecessary information into fork commit history.
- In your fork, click New pull request.
- Click the "switching the base" link and then click Create pull request.
- Provide a descriptive name for your pull request in the provided field.
- Scroll to the bottom of the page and click Merge pull request, then click Confirm Merge.
Create a pull request
First, check the existing PRs and make sure you are not duplicating others’ work!
To create a pull request do the following:
- Create a feature branch for your changes and push those changes to the copy of your repository on GitHub. This is the best way to organize and even update your PR.
- In your repository, click Pull requests, and then click New pull request.
- Ensure that you are creating a PR to the magento/magento2-functional-testing-framework: develop branch. We accept PRs to this branch only.
- Review the changes, then click Create pull request. Fill out the form, and click Create pull request again to submit the PR—that’s it!
Learn more in the Creating a pull request GitHub article.
After submitting your PR, you can head over to the repository’s Pull Requests panel to see your PR along with the others. Your PR undergoes automated testing, and if it passes, the core team considers it for inclusion in the Magento Functional Testing Framework codebase. If some tests fail, make the corresponding corrections in your code.
Report an issue
If you find a bug in Magento Functional Testing Framework code, you can report it by creating an issue in the Magento Functional Testing Framework repository.
Before creating an issue, do the following:
- Read the issue reporting guidelines to learn how to create an issue that can be processed in a timely manner.
- Check the documentation to make sure the behavior you are reporting is really a bug, not a feature.
- Check the existing issues to make sure you are not duplicating somebody’s work.
To add an issue:
- Open a new issue
- Fill in the Title and issue description
- Click Submit new issue
Learn more in the Creating an issue GitHub article.
Read labels
Refer to the tables with descriptions of each label below. The labels reflect the status, impact, or which team is working on it.
Pull request status
| Label | Description |
|---|---|
| accept | The pull request has been accepted to be merged into mainline code. |
| 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. |
| needsUpdate | We need more information from the PR author to properly prioritize and process the pull request. |
Issue resolution status
| Label | Description |
|---|---|
| acknowledged | We validated the issue and created an internal ticket. |
| needsUpdate | We need more information from the PR author to properly prioritize and process the issue. |
| cannot reproduce | We do not have enough details from the issue description to reproduce the issue. |
| non-issue | We don't think that this is an issue according to the provided information. |
Domains impacted
| Label | Description |
|---|---|
| PROD | Affects the Product team (mostly feature requests or business logic change). |
| DOC | Affects Documentation domain. |
| TECH | Affects Architect Group (mostly to make decisions around technology changes). |
Type
| Label | Description |
|---|---|
| bugfix | The issue or pull request is about fixing a bug. |
| enhancement | The issue or pull request that makes the MFTF even more awesome (for example new features, optimization, refactoring, etc). |