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
+6-4Lines changed: 6 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ As you contribute PRs, you gain [Contribution Points](https://devdocs.magento.co
14
14
15
15
If you write and contribute a full topic, we will add your name (or your company's name) at the top of the DevDocs page and link it to your blog or website!
16
16
17
-
## Get started
17
+
## Get started
18
18
19
19
20
20
@@ -28,12 +28,13 @@ If you write and contribute a full topic, we will add your name (or your company
1. Create a new branch on your fork. Use a name that best describes the work, or references a GitHub issue number.
31
-
1. Edit or create markdown (`.md`) files in your branch.
31
+
1. Edit or create markdown (`.md`) files in your branch.
32
32
1. When ready, push your branch to your fork.
33
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
34
35
-
The DevDocs team and Maintainers will review the PR and help with formatting and navigation.
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`.
36
36
37
+
The DevDocs team and Maintainers will review the PR and help with formatting and navigation.
37
38
38
39
**Note:** If you have not signed the [Magento Contributor Agreement](https://magento.com/content/magento-contributor-agreement), the PR provides a link. We require a signed form and agreement to the terms for contribution.
39
40
@@ -49,6 +50,7 @@ The following guidelines may answer most of your questions and help you get star
49
50
50
51
1. Check [existing pull requests](https://github.com/magento/devdocs/pulls) and make sure you are not duplicating work!
51
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.
52
54
1. Familiarize yourself with the existing documentation. Look through and search the guides to decide where to add your topics.
53
55
54
56
- The DevDocs team can find the best home for your new topics and add it to the navigation.
@@ -63,6 +65,7 @@ Use the following guidelines to help you with the writing process:
63
65
- Define the goal of your topic. What exactly do you want to teach the reader?
64
66
- Make the title of your topic reflect the content.
65
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.
66
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..."_.
67
70
- Use notes to alert readers about important details.
68
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.
@@ -93,7 +96,6 @@ title: Continue with your installation
0 commit comments