Skip to content

Commit 075a141

Browse files
Correcting formatting and adding use case example
1 parent 58ae308 commit 075a141

File tree

5 files changed

+499
-171
lines changed

5 files changed

+499
-171
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
1-
21
# Contributing to Magento code
32

4-
## Overview
5-
63
Contributions to the Magento codebase are done using the fork & pull model.
74
This contribution model has contributors maintaining their own copy of the forked codebase (which can easily be 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 (hence the phrase “pull request”).
85

9-
Contributions can take the form of new components/features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes, optimizations or just good suggestions.
6+
Contributions can take the form of new components/features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes, optimizations, or just good suggestions.
107

11-
The Magento development team will review all issues and contributions submitted by the community of developers in first in, first out order. 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.
8+
The Magento development team will review all issues and contributions submitted by the community of developers in first-in, first-out order. 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.
129

1310
For large features or changes, please [open an issue](https://github.com/magento/composer-root-update-plugin/issues) for discussion before submitting any code. This will prevent duplicate or unnecessary effort and can also increase the number of people involved in discussing and implementing the change.
1411

1512
## Contribution requirements
1613

17-
1. Contributions must adhere to [Magento coding standards](http://devdocs.magento.com/guides/v2.0/coding-standards/bk-coding-standards.html).
14+
1. Contributions must adhere to [Magento coding standards](http://devdocs.magento.com/guides/v2.3/coding-standards/bk-coding-standards.html).
1815
2. Pull requests (PRs) must be accompanied by a complete and meaningful description. Comprehensive descriptions make it easier to understand the reasoning behind a change and reduce the amount of time required to get the PR merged.
1916
3. Commits must be accompanied by meaningful commit messages.
20-
4. PRs which include bug fixing must be accompanied with step-by-step descriptions of how to reproduce the issue (including the local composer version reported by `composer --version`).
17+
4. PRs which include bug fixing must be accompanied by step-by-step instructions how to reproduce the issue (including the local composer version reported by `composer --version`).
2118
5. PRs which include new logic or new features must be submitted along with:
2219
* Unit/integration test coverage where applicable.
2320
* Updated documentation in the project's `docs` directory.
@@ -27,19 +24,19 @@ Any contributions that do not meet these requirements will not be accepted.
2724

2825
### Composer compatibility
2926

30-
Maintaining compatibility with the Composer versions listed in [composer.json](composer.json) is of particular note for this project. Due to the way Composer works with plugins, the version that is used when the plugin runs is the local `composer.phar` executable version (as reported by `composer --version`) and not the version installed in the project's `vendor` folder or `composer.lock` file. This means that in order to properly verify Composer compatibility, tests must be run against the local `composer.phar` executable, not just the installed `composer/composer` dependency.
27+
Maintaining compatibility with the Composer versions listed in the [composer.json](composer.json) file is important for this project. Due to the way Composer works with plugins, the version that is used when the plugin runs is the local `composer.phar` executable version (as reported by `composer --version`) and not the version installed in the project's `vendor` folder or `composer.lock` file This means that in order to properly verify Composer compatibility, tests must be run against the local `composer.phar` executable, not just the installed `composer/composer` dependency.
3128

3229
Additionally, because of the way the plugin interacts with the native `composer require` command, some parts of the Composer library sometimes need to be re-implemented in an accessible manner if the original code is in private methods or part of larger functions. Such implementations should be located in the [Magento\ComposerRootUpdatePlugin\ComposerReimplementation](src/Magento/ComposerRootUpdatePlugin/ComposerReimplementation) namespace and documented with the reason for re-implementation and a link to the original method.
3330

3431
## Contribution process
3532

36-
If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). By doing so, you will be able to collaborate with the Magento development team, fork the github project and easily send pull requests for any changes you wish to contribute.
33+
If you are a new GitHub user, we recommend that you create your own [free GitHub account](https://github.com/signup/free). By doing so, you will be able to collaborate with the Magento development team, fork the GitHub project and easily send pull requests for any changes you wish to contribute.
3734

3835
1. Search the current listed issues (open or closed) on the [magento/composer-root-update-plugin](https://github.com/magento/composer-root-update-plugin/issues) and [magento/magento2](https://github.com/magento/magento2/issues) GitHub repositories before starting work on a new contribution.
3936
2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing.
4037
3. Create and test your work.
41-
4. Fork the repository according to the [Fork a repository instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#fork).
42-
5. When you are ready to send us a pull request, follow the [Create a pull request instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#pull_request). The instructions are written for the `https://github.com/magento/magento2` repository, but they also apply to `https://github.com/magento/composer-root-update-plugin`.
38+
4. Fork the repository according to the [Fork a repository instructions](http://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#fork).
39+
5. When you are ready to send us a pull request, follow the [Create a pull request instructions](http://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#pull_request). The instructions are written for the `https://github.com/magento/magento2` repository, but they also apply to `https://github.com/magento/composer-root-update-plugin`.
4340
6. Once your contribution is received, the Magento 2 development team will review the contribution and collaborate with you as needed if it is accepted.
4441

4542
## Code of Conduct

0 commit comments

Comments
 (0)