Skip to content

Commit c621ac4

Browse files
author
Lori Krell
authoredSep 14, 2018
Updated contributing accepted PRs for all versions and basic template
GH2917 - Add note on accepted PRs in code and metadata for template
2 parents 2f05ca8 + 65ed5af commit c621ac4

File tree

9 files changed

+860
-9
lines changed

9 files changed

+860
-9
lines changed
 

‎_includes/contributor/2-1-end.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{:.bs-callout .bs-callout-warning}
2+
**v2.1 End of Contribution:**
3+
As of September 17, 2018, we no longer accept contributions to the v2.1 release line. Continue submitting contributions for the [v2.2](https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing.html) and [v2.3](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html) release lines. We made this change to increase our focus on issue investigations and pull request approvals for v2.2 and v2.3 release lines.
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{:.bs-callout .bs-callout-info}
2+
**v2.2 Contribution Notice:**
3+
As of September 17, 2018, in an effort to keep 2.2 and 2.3 releases aligned, we will only accept pull requests to 2.2-develop that contain changes already existing in 2.3-develop. We recommend submitting pull requests to 2.3-develop then [back porting](#porting) the changes to 2.2-develop.
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{:.bs-callout .bs-callout-info}
2+
**v2.3 Contribution Notice:**
3+
As of September 17, 2018, in an effort to keep 2.2 and 2.3 releases aligned, we accept pull requests to 2.3-develop and encourage [back ports](#porting) to 2.2-develop. We no longer accept pull requests to the v2.1 or v2.0 release lines to focus all development efforts on v2.3 and v2.2.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
| | Fix for Existing Issue | Test Coverage | Refactoring | New Feature | Code Cleanup |
2+
|:----|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|
3+
| 2.1 | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) |
4+
| 2.2 | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) |
5+
| 2.3 | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) |

‎guides/v2.1/contributor-guide/contributing.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
group: contributor-guide
33
title: Code Contributions
4-
redirect_from: /guides/v2.0/contributor-guide/contributing.html
54
---
65

6+
{% include contributor/2-1-end.md %}
7+
78
The following topics are included in this guide:
89

910
- [Contribute to Magento 2 code](#contribute)
@@ -49,13 +50,11 @@ Submit feature requests or enhancement suggestions to the new [Magento 2 Feature
4950

5051
## Accepted pull requests and ported code {#rules}
5152

53+
{% include contributor/2-1-end.md %}
54+
5255
Please review the following supported and accepted pull request rules. We defined these rules to simplify and accelerate your submissions, follow code consistency, manage current and backlog tasks, and so on.
5356

54-
| | Fix for Existing Issue | Test Coverage | Refactoring | New Feature | Code Cleanup |
55-
|:----|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|
56-
| 2.1 | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) |
57-
| 2.2 | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![No]({{site.baseurl}}/common/images/red-x.png) | ![No]({{site.baseurl}}/common/images/red-x.png) |
58-
| 2.3 | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) | ![Yes]({{site.baseurl}}/common/images/green-check.png) |
57+
{% include contributor/pull-request-table.md %}
5958

6059
## Contribution requirements {#requirements}
6160

@@ -108,6 +107,8 @@ Check out this video to see the process in action:
108107

109108
## Create a pull request {#pull_request}
110109

110+
{% include contributor/2-1-end.md %}
111+
111112
First, check the [existing PRs](https://github.com/magento/magento2/pulls?q=is%3Aopen+is%3Apr){:target="_blank"} and make sure you are not duplicating others’ work.
112113

113114
To create a pull request:

‎guides/v2.1/contributor-guide/templates/basic_template.md

+19
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,25 @@ The purpose of this page is to provide you with a pre-formatted template and use
1212

1313
You can start off by editing the local version of this file using markdown language (and {% glossarytooltip a2aff425-07dd-4bd6-9671-29b7edefa871 %}HTML{% endglossarytooltip %} where needed). Then, create a Pull Request to have your contribution reviewed by the DevDocs team.
1414

15+
## Metadata parameters
16+
17+
Add the following metadata parameters at the top of your page. We use YAML for the metadata in front matter. We use this data when generating the DevDocs for the following:
18+
19+
Parameter | Description
20+
--- | ---
21+
`group:` | The table of contents this file belongs to, which points to files located in `_data/toc/`. Only add the name of the file without the extension. For example, the group of this file is `group: contributor-guide`, which points to the table of contents defined in `_data/toc/contributor-guide.yml`.
22+
`title:` | The title of the page.
23+
`functional_areas:` | Optional. Adds facets for search results. Available facets include: Sales, Products, Carts, Customers, Marketing, Account, Content, Reports, Stores, System, Catalog, Orders, Frontend, Theme, Staging, Search, Configurations, Integration, Services, Tools, Setup, Testing, test, Standards, Install, Upgrade, B2B, Cloud, and Bundled extensions. These facets are case sensitive and support multiple facets separated by commas. For example: `functional_areas: Install`.
24+
`redirect_from` | Optional. Add a list of other pages in DevDocs that should redirect to this page. The link should start with the `/guides` directory. For an example, see the source code for this template page.
25+
`ee_only:` | Optional. If set to `true`, graphics/cues display on the page indicating it applies to {{site.data.var.ee}}.
26+
{:style="table-layout:auto;"}
27+
28+
{%
29+
include note.html
30+
type='info'
31+
content='If you need help with metadata, we can help in your submitted pull requests.'
32+
%}
33+
1534
## Basic Markdown Syntax {#basic}
1635

1736
Below are some basic examples of what you can do with markdown.

‎guides/v2.1/contributor-guide/templates/tutorial-template-first.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A tutorial provides procedural information spread across multiple pages. It cont
1717

1818
## Metadata parameters
1919

20-
You must use the following {% glossarytooltip 3f0f2ef1-ad38-41c6-bd1e-390daaa71d76 %}metadata{% endglossarytooltip %} parameters on the tutorial index page.
20+
You must use the following metadata parameters on the tutorial index page.
2121

2222
Parameter | Description
2323
--- | ---
@@ -27,6 +27,8 @@ Parameter | Description
2727
`menu_title:` | On the index page of the tutorial, specify `Initial tasks`.
2828
`menu_order:` | The sequence number of the topic. For the index page in a multi-step tutorial, set this 0.
2929
`return_to:` | Defines the tutorial's parent page. The parent page title is displayed in the left navigation above the tutorial steps. Do not specify a value for the `return_to:` parameter. Instead, specify values for these second-level parameters:<br/><br/>`title:` The title of the parent topic<br/><br/>`url:` The URL of the parent topic
30+
`functional_areas:` | Optional. Adds facets for search results. Available facets include: sales, products, carts, customers, marketing, account, content, reports, stores, system, catalog, orders, frontend, theme, staging, search, configurations, integration, services, tools, setup, testing or test, standards, install, upgrade, B2B, cloud, and bundled extensions.
31+
`redirect_from` | Optional. Add a list of other pages in DevDocs that should redirect to this page. The link should start with the `/guides` directory. For an example, see the source code for this template page. |
3032
`ee_only:` | Optional. If set to `true`, graphics/cues indicating that the article applies to {{site.data.var.ee}} are displayed on devdocs.
3133
{:style="table-layout:auto;"}
3234

‎guides/v2.2/contributor-guide/contributing.md

-1
This file was deleted.

‎guides/v2.2/contributor-guide/contributing.md

+409
Large diffs are not rendered by default.

‎guides/v2.3/contributor-guide/contributing.md

-1
This file was deleted.

‎guides/v2.3/contributor-guide/contributing.md

+408
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
Please sign in to comment.