Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6de892a

Browse files
committed
MAGECLOUD-2803: Revise per peer review
1 parent c1652e5 commit 6de892a

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

guides/v2.0/contributor-guide/contributing_docs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ We use [Markdown](http://daringfireball.net/projects/markdown/){:target="\_blank
3030

3131
1. Familiarize yourself with the existing documentation; taking a look at what is already there will help you decide where your topic best fits. The DevDocs team can also help find the best home for your new topics.
3232

33-
1. Focus on the content and on creating useful information for your fellow Magento developers and community members, but do not forget to review your work for typos, formatting errors, or sentences that need clarifying before opening a pull request.
33+
1. Focus on the content and on creating useful information 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.
3434

3535
1. Use the following guidelines to help you with the writing process:
3636

@@ -39,7 +39,7 @@ We use [Markdown](http://daringfireball.net/projects/markdown/){:target="\_blank
3939
- Keep your sentences concise and try to separate conceptual information from procedural steps.
4040
- Remember to use active voice (not passive), write in the present tense, and use a friendly tone in second person. For example, _"You can now view the output..."_.
4141
- Use notes to alert readers about important details.
42-
- Use cross-references to other topics if appropriate. We can help you with the syntax if it is not clear and the template has an example.
42+
- 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.
4343

4444
## Fork and clone a repository {#fork}
4545
Use the [fork](#fork) and [pull](#create-a-pull-request) model to contribute to Magento DevDocs. This model requires you to keep your forked repository in sync with the upstream repository. You submit pull requests to _pull_ a set of changes from your forked repository to the upstream repository.
@@ -52,7 +52,7 @@ To fork the devdocs repository on Github, do the following:
5252

5353
1. Click **Fork** at the top right.
5454

55-
1. Clone the repository into your development environment and then start writing and committing your changes. Optionally create a branch first if you plan to work on multiple changes.
55+
1. Clone the repository into your development environment and then start writing and committing your changes. Optionally, create a branch first if you plan to work on multiple changes.
5656

5757
1. Build the devdocs site locally using Jekyll by following the instructions in our [README](https://github.com/magento/devdocs/blob/develop/README.md){:target="\_blank"}.
5858

@@ -72,7 +72,7 @@ It is also possible to use the GitHub interface to update your fork. This is ref
7272

7373
1. Enter a name for your pull request.
7474

75-
1. Scroll to the bottom of the page and click **Merge pull request**
75+
1. Scroll to the bottom of the page and click **Merge pull request**.
7676

7777
1. Click **Confirm Merge**.
7878

guides/v2.0/contributor-guide/contributing_docs_suggested.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ If you are interested in working on one of these projects, open a [pull request
7676
<p><strong>Acceptance criteria:</strong></p>
7777
<ul>
7878
<li>Provide an extended explanation of the parameters <code>(key => value)</code> for the <code>addAttribute</code> function.
79-
<p>For example <code>'type' => 'int'</code> and a list of all possible keys and their corresponding possible values.</p></li>
79+
<p>For example, <code>'type' => 'int'</code> and a list of all possible keys and their corresponding possible values.</p></li>
8080
<li>Provide an extended explanation of the XML tags inside the tag. For example:
8181
<ul>
8282
<li>What basic structure should always be applied?</li>
@@ -104,7 +104,7 @@ If you are interested in working on one of these projects, open a [pull request
104104
<li>Log specific servers and networked logging</li>
105105
<li>Logging in development</li>
106106
</ul></li>
107-
<li>Differentiate between versions of Magento, if applicable</li>
107+
<li>Differentiate between versions of Magento, if applicable.</li>
108108
</ul>
109109
</td>
110110
<td></td>

0 commit comments

Comments
 (0)