Skip to content

Commit 1fc3f75

Browse files
committed
MC-4181: Organize Existing Topics
Fixed spelling mistake and docs path in the root Contributing.md for GitHub.
1 parent 468425c commit 1fc3f75

File tree

1 file changed

+33
-17
lines changed

1 file changed

+33
-17
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Contributing to Magento 2 code
2-
3-
<!--{% comment %}-->
2+
<!-- {% comment %} -->
43
## Navigation
54

65
1. [Introduction]
@@ -14,14 +13,34 @@
1413
5. [Roadmap and known issues]
1514
6. [How to create custom PageBuilder content type container]
1615

17-
[Introduction]: docs/introduction.md
18-
[Installation guide]: docs/install.md
19-
[Developer documentation]: docs/developer-documentation.md
20-
[Roadmap and Known Issues]: docs/roadmap.md
21-
[How to create custom PageBuilder content type container]: docs/how-to-create-custom-content-type-container.md
22-
<!--{% endcomment %}-->
23-
24-
<!-- {% raw %} -->
16+
[Introduction]: introduction.md
17+
[Contribution guide]: CONTRIBUTING.md
18+
[Installation guide]: install.md
19+
[Developer documentation]: developer-documentation.md
20+
[Architecture overview]: architecture-overview.md
21+
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
22+
[Third-party content type migration]: new-content-type-example.md
23+
[Iconography]: iconography.md
24+
[Add image uploader to content type]: image-uploader.md
25+
[Module integration]: module-integration.md
26+
[Additional data configuration]: custom-configuration.md
27+
[Content type configuration]: content-type-configuration.md
28+
[How to add a new content type]: how-to-add-new-content-type.md
29+
[Events]: events.md
30+
[Bindings]: bindings.md
31+
[Master format]: master-format.md
32+
[Visual select]: visual-select.md
33+
[Reuse product conditions in content types]: product-conditions.md
34+
[Store component master format as widget directive]: widget-directive.md
35+
[Use the block chooser UI component]: block-chooser-component.md
36+
[Use the inline text editing component]: inline-editing-component.md
37+
[Render a backend content type preview]: content-type-preview.md
38+
[Custom Toolbar]: toolbar.md
39+
[Full width page layouts]: full-width-page-layouts.md
40+
[Add image uploader to content type]: image-uploader.md
41+
[Roadmap and Known Issues]: roadmap.md
42+
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
43+
<!-- {% endcomment %} -->
2544
## Overview
2645

2746
Contributions to the Magento 2 codebase are done using the fork & pull model.
@@ -40,16 +59,15 @@ The Magento 2 development team will review all issues and contributions submitte
4059
4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
4160
3. PRs which include new logic or new features must be submitted along with:
4261
* Unit/integration test coverage where applicable.
43-
* Updated documentation in the module directory `app/code/PageBuilder/docs`.
44-
4. For large features or changes, please [open an issue](https://github.com/magento/magento2/issues) and discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
45-
5. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
62+
* Updated documentation in the `docs` directory at the root level.
63+
1. For large features or changes, please [open an issue](https://github.com/magento/magento2/issues) and discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
64+
2. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
4665

4766
## Contribution process
4867

4968
If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). By doing that, you will be able to collaborate with the Magento 2 development team, “fork” the Magento 2 project and be able to easily send “pull requests”.
5069

51-
1. Search current [listed issues](https://github.com/magento/magento2-page-builder/issues) on GitHub (open or closed) and [list of known issues](docs/roadmap.md#Known Issues) on our roadmap for similar proposals of intended contribution before starting work on a new contribution.
52-
2. Please contact us in Slack chanel if you want to work on issue from [list of known issues](docs/roadmap.md#Known Issues).
70+
1. Search current [listed issues](https://github.com/magento/magento2-page-builder/issues) on GitHub (open or closed) before starting work on a new contribution.
5371
2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing.
5472
3. Create and test your work.
5573
4. Fork the Magento 2 repository according to [Fork a repository instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow [Create a pull request instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#pull_request). Instructions written for `https://github.com/magento/magento2` repository, but they also apply to `https://github.com/magento/magento2-page-builder`.
@@ -59,5 +77,3 @@ If you are a new GitHub user, we recommend that you create your own [free github
5977

6078
Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project.
6179
The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).
62-
63-
<!-- {% endraw %} -->

0 commit comments

Comments
 (0)