Skip to content

Commit

Permalink
Updating readme to reflect large grammer updates (mdn#7824)
Browse files Browse the repository at this point in the history
* rel notes

* updating readme with grammar note

* removing lines

* lint

Co-authored-by: Ruth John <[email protected]>
  • Loading branch information
Rumyra and Ruth John authored Aug 16, 2021
1 parent 318bcf1 commit 224b15b
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,15 +360,20 @@ for each logical set of changes that belong together.
improvement, or formatting/structural change), please describe why you're
making the change and anything else we need to know about it.
- If the pull request is simple (it is really clear what has been
changed and why, and the change is obviously a good thing), you can do
this in your pull request's description.
changed and why, and the change is obviously a good thing), you can do
this in your pull request's description.
- If the pull request is complex (the changes and the reasoning behind
them need a bit more explanation), then the requestor should file an
issue describing the intended change first, and seek discussion/approval
as needed. When the time is right to submit the PR, they should
reference the issue (or an existing issue that describes the motivation
for the change) in the PR. You can reference an existing issue
using `#` followed by the issue's ID, for example `#1234`.
them need a bit more explanation), then the requestor should file an
issue describing the intended change first, and seek discussion/approval
as needed. When the time is right to submit the PR, they should
reference the issue (or an existing issue that describes the motivation
for the change) in the PR. You can reference an existing issue
using `#` followed by the issue's ID, for example `#1234`.
- Pull requests should not contain large amounts of grammar updates.
Seemingly insignificant changes can change the meaning of technical
content, so these need a careful review. Keep in mind that MDN contains
technical documentation; you should not report merely basic improvements
in the grammar but only cases where the grammar is incorrect.

1. Do not re-open a pull request that a reviewer has closed.

Expand Down

0 comments on commit 224b15b

Please sign in to comment.