This repository has been archived by the owner on Aug 26, 2022. It is now read-only.
bug 957802: Add Code of Conduct, Update Contributing doc #4674
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add the MDN Code of Conduct, and refresh CONTRIBUTING for current practices: * Our process is much closer to GitHub flow than the old WebDev workflow * We have a lot more to say about code style, expecially around tests * Add more guidance around branch names and commit messages * Add more about the code review and deployment processes * Add expectations for a PR to be touched in 2 business days * Drop requirement for two peers to review database changes
jwhitlock
force-pushed
the
contributing-957802
branch
from
7774b14
to
a33bfb0
Compare
Fix some issues that are easier to see when GitHub is rendering the markdown, like long sentence, adding formatting, and fixing links,
escattone
suggested changes
Feb 21, 2018
There was a problem hiding this comment.
❤️ Wow! This is a really nice step forward. I even learned some new things reading it, as well as some things I need to improve! Thanks @jwhitlock!
Just a few typos to fix.
CONTRIBUTING.md
Outdated
| =============== | ||
| The MDN platform is a mature product, which means there aren't always bugs that | ||
| are suitable for new contributors. We keep a list of starting mentored bugs on | ||
| the [MDN "Getting Involved" page](get-involved). There are interesting MDN |
There was a problem hiding this comment.
Typo: Replace (get-involved) with [get-involved]
CONTRIBUTING.md
Outdated
| and give feedback, or to tell you when we plan to review it. | ||
|
|
||
| [gh-flow]: https://guides.github.com/introduction/flow/ | ||
| [install]: https://kuma.readthedocs.io/en/latest/installation.html. |
There was a problem hiding this comment.
Typo: remove trailing period (should be https://kuma.readthedocs.io/en/latest/installation.html)
CONTRIBUTING.md
Outdated
| =============== | ||
| The MDN platform is a mature product, which means there aren't always bugs that | ||
| are suitable for new contributors. We keep a list of starting mentored bugs on | ||
| the [MDN "Getting Involved" page](get-involved). There are interesting |
There was a problem hiding this comment.
Typo: replace (get-involved) with [get-involved]
CONTRIBUTING.md
Outdated
| good code as well as bad, be clear when changes are needed, and offer | ||
| suggestions for fixing code. Code authors should ask questions when a | ||
| suggestion is unclear, and ask for help if needed. On both sides, the review | ||
| should be about the code, not the person, and the [code of conduct](coc) must |
There was a problem hiding this comment.
Typo: replace (coc) with [coc]
[Foo](bar) links to ./bar, but [Foo][bar] uses the later reference [bar]
|
Thanks for checking the links! I'm new to that format for Markdown links. |
escattone
approved these changes
Feb 22, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add the MDN Code of Conduct, and refresh CONTRIBUTING for current practices: