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
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+25-17Lines changed: 25 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,16 @@ If you write and contribute a full topic, we will add your name (or your company
30
30
1. Create a new branch on your fork. Use a name that best describes the work, or references a GitHub issue number.
31
31
1. Edit or create markdown (`.md`) files in your branch.
32
32
1. When ready, push your branch to your fork.
33
-
1. Create a PR to the [magento/devdocs repo](https://github.com/magento/devdocs). Fill out as much info as possible and link any GitHub issues.
34
33
35
-
In general, you should use `master` as the base branch when creating a PR. If your contribution is related to a release that is in progress, use a version-specific integration branch, like `2.3.1-integration`.
34
+
### Create a pull request
35
+
36
+
Create a PR to the [magento/devdocs repository](https://github.com/magento/devdocs). Fill out as much information as possible and link any GitHub issues.
37
+
38
+
In general, you should use `master` as the base branch when creating a PR. If your contribution is related to a release that is in progress, use a version-specific integration branch, such as `develop`.
39
+
40
+
Provide links to devdocs for the files you are changing. This is not required if the list is long.
41
+
42
+
If you are updating an example from source code, include a link to the file in the repository.
36
43
37
44
The DevDocs team and Maintainers will review the PR and help with formatting and navigation.
38
45
@@ -42,34 +49,34 @@ The DevDocs team and Maintainers will review the PR and help with formatting and
42
49
43
50
## Contribution guidelines
44
51
45
-
Write content using [Kramdown](https://kramdown.gettalong.org/), which is a simple markup language. We use Kramdown, Liquid, and [Jekyll](https://jekyllrb.com/) to generate a static site hosted through [GH Pages](https://help.github.com/articles/what-is-github-pages/). Check [Templates](#templates) for examples of styles and markdown.
52
+
Write content using [kramdown](https://kramdown.gettalong.org/), which is a simple markup language. We use kramdown, Liquid, and [Jekyll](https://jekyllrb.com/) to generate a static site hosted through [GH Pages](https://help.github.com/articles/what-is-github-pages/). Check [Templates](#templates) for examples of styles and markdown.
46
53
47
54
You can update existing or add new topics in their respective Magento 2 versioned directories (2.1, 2.2, 2.3, and onward). If you need help finding a directory for your content, we can help in your PR.
48
55
49
56
The following guidelines may answer most of your questions and help you get started:
50
57
51
-
1.Check [existing pull requests](https://github.com/magento/devdocs/pulls) and make sure you are not duplicating work!
52
-
1.For large contributions or changes that include multiple files, [open an issue](#report-an-issue) and discuss it with us first. This may further prevent duplicate or unnecessary effort.
53
-
1.[Chunk many small/medium changes](#tips-for-writing-content) into one or two PRs. This helps us to efficiently and effectively facilitate your contribution.
54
-
1.Familiarize yourself with the existing documentation. Look through and search the guides to decide where to add your topics.
58
+
1. Check [existing pull requests](https://github.com/magento/devdocs/pulls) and make sure you are not duplicating work!
59
+
1. For large contributions or changes that include multiple files, [open an issue](#report-an-issue) and discuss it with us first. This may further prevent duplicate or unnecessary effort.
60
+
1.[Chunk many small/medium changes](#tips-for-writing-content) into one or two PRs. This helps us to efficiently and effectively facilitate your contribution.
61
+
1. Familiarize yourself with the existing documentation. Look through and search the guides to decide where to add your topics.
55
62
56
-
-The DevDocs team can find the best home for your new topics and add it to the navigation.
57
-
-If a topic has a symlink, you can remove it with Git commands and add a new file. Copy and paste a previous version of the topic to get started.
63
+
- The DevDocs team can find the best home for your new topics and add it to the navigation.
64
+
- If a topic has a symlink, you can remove it with Git commands and add a new file. Copy and paste a previous version of the topic to get started.
58
65
59
66
## Tips for writing content
60
67
61
68
Focus on the content with useful information, code samples, and important notes for your fellow Magento developers and community members. Don't forget to review your work for typos, formatting errors, or sentences that need clarifying before opening a pull request.
62
69
63
70
Use the following guidelines to help you with the writing process:
64
71
65
-
-Define the goal of your topic. What exactly do you want to teach the reader?
66
-
-Make the title of your topic reflect the content.
67
-
-Keep your sentences concise and try to separate conceptual information from procedural steps.
68
-
-Batch several small changes into a single pull request (instead of separate ones) to ensure your contributions get approved and merged quickly. Have several typo fixes across several areas of documentation? Batch them into on PR.
69
-
-Remember to use active voice (not passive), write in the present tense, and use a friendly tone in second person. For example, _"The log captures commands, output..."_.
70
-
-Use notes to alert readers about important details.
71
-
-Use cross-references to other topics if appropriate. We can help you with the syntax if it is not clear. The template provides an example you can use.
72
-
-Need help with markdown? See our [templates](#templates).
72
+
- Define the goal of your topic. What exactly do you want to teach the reader?
73
+
- Make the title of your topic reflect the content.
74
+
- Keep your sentences concise. Separate conceptual information from procedural steps.
75
+
- Batch several small changes into a single pull request (instead of separate ones) to ensure your contributions get approved and merged quickly. Have several typo fixes across several areas of documentation? Batch them into one PR.
76
+
- Remember to use active voice (not passive), write in the present tense, and use a friendly tone in second person. For example, _"The log captures commands, output..."_.
77
+
- Use notes to alert readers about important details.
78
+
- Use cross-references to other topics if appropriate. We can help you with the syntax if it is not clear. The template provides an example you can use.
79
+
- Need help with markdown? See our [templates](#templates).
73
80
74
81
### Preview your work on local
75
82
@@ -111,6 +118,7 @@ Enter as much information as you can including content corrections, steps to rep
111
118
**Note:** Check the [existing issues](https://github.com/magento/devdocs/issues) on GitHub to see if someone has already reported the issue.
112
119
113
120
You have a couple of options to enter an issue:
121
+
114
122
- Have general feedback? Create an issue on [GitHub DevDocs](https://github.com/magento/devdocs/issues/new/choose).
115
123
- Have feedback on a specific DevDocs page? Click the **Give us feedback** link at the top right of the page to report on the currently open topic.
Please fill out as much information as you can about your PR to help speed up the review process.
32
-
If your PR addresses an existing GitHub Issue, please refer to it in the title or Additional Information section to make the connection.
18
+
- ...
19
+
- ...
33
20
34
-
We may ask you for changes in your PR in order to meet the standards set in our Contribution Guidelines. PR's that do not comply with our guidelines may be closed at the maintainers' discretion.
21
+
<!--
22
+
If you are fixing a Github issue, note it in the following format and the issue will automatically close when this PR is merged:
23
+
Fixes #<IssueNumber>
35
24
36
-
Feel free to remove this section before creating this PR.
25
+
`master` is the default branch. PRs to this branch should be for current devdocs content. Merged PRs to master go live on the site automatically. Work for future releases generally goes in the `develop` branch. Work with the devdocs team if you are unsure where to submit your PR.
0 commit comments