Add Contributing.md #2699
Add Contributing.md #2699
Conversation
There was a problem hiding this comment.
Looks good to me, thanks. I'll make a note to also consolidate this as part of https://github.com/mozilla/addons-frontend/issues/2223
CONTRIBUTING.md
Outdated
| Contributing | ||
| ============ | ||
|
|
||
| If you’re not sure this is the correct place to file an issue then please file an issue on the [mozilla/addons] project instead. |
There was a problem hiding this comment.
If you’re not sure this is the correct place to file an issue then please file an issue on the [mozilla/addons] project instead.
Could use with some more context. The first paragraph should provide more info:
This is the code for the Mozilla Add-ons website frontend–it's the code that displays Add-ons to user from the Add-ons (API) Server. This project handles the display of data and submission of things like reviews to the API, but doesn't handle the data. If you’re not sure this is the correct place to file an issue then please file an issue on the [mozilla/addons] project instead.
CONTRIBUTING.md
Outdated
|
|
||
| If you’re not sure this is the correct place to file an issue then please file an issue on the [mozilla/addons] project instead. | ||
|
|
||
| Before contributing code, please note: |
There was a problem hiding this comment.
"Before contributing" should suffice, I'd remove the word "code".
CONTRIBUTING.md
Outdated
|
|
||
| Before contributing code, please note: | ||
|
|
||
| - You agree to license your contributions under the [license]. |
There was a problem hiding this comment.
I thought we mostly used * for lists, but it's just a nit.
There was a problem hiding this comment.
Ah that's pandoc's fault :) - I converted this from rst here: https://github.com/mozilla/addons-server/blob/master/CONTRIBUTING.rst
CONTRIBUTING.md
Outdated
| Before contributing code, please note: | ||
|
|
||
| - You agree to license your contributions under the [license]. | ||
| - Please ask on the [dev-addons mailing list] before submitting pull-requests for new features or large changes that are not related to existing issues. |
There was a problem hiding this comment.
I would say "Please file issues or ask on the dev-addons list". No reason the discussion can't happen on here.
CONTRIBUTING.md
Outdated
|
|
||
| If you come across a potential `good first bug` for contributors, please tag it with `maybe good first bug`. The community team [triages] these every other week to ensure they have mentors assigned, onboarding information, and basic steps to get started. This gives new contributors a better experience when they pick a “good first bug” to work on. | ||
|
|
||
|
|
There was a problem hiding this comment.
Could remove a few of these empty lines.
Add contributing markdown file (based on the addons-server one with a few small changes)