-
-
Notifications
You must be signed in to change notification settings - Fork 49
Added CONTRIBUTING.md #52
Conversation
cldougl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wbrgss awesome much-needed addition!!
no blocking issues for me so
💃after considering my comments 🎉
CONTRIBUTING.md
Outdated
|
|
||
| ## Pull Request Guidelines | ||
|
|
||
| Using the [GitHub flow][] is encouraged when proposing contributions to this repository (i.e. creating a feature branch and submitting a PR on the master branch). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's change:
Using the [GitHub flow][] is encouraged
to
Use the [GitHub flow][]
I'd say this is more mandatory than encouraged 😆
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
then grammatically I think we'd want to change the last bit to:
(i.e. create a feature branch and submit a PR against the master branch).
CONTRIBUTING.md
Outdated
|
|
||
| If your company wishes to sponsor development of open source dash components, please [get in touch][]. | ||
|
|
||
| ### Notes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not blocking-- but I would suggest removing the note and just working the link https://dev.w3.org/html5/html-author/#index-of-elements inline in the contribution section. That's a good comprehensive list so I find it important enough to be inline and we may consider adding a notes section in the future when we have more notes to add.
Follow-up on a task in the onboarding checklist:
The advantage of having a CONTRIBUTING.md file is that GitHub will suggest reading it when contributors open their first issue or PR:
I'm not intimately familiar with the workflow on this repo, so this should be considered a first stab at a more helpful guide, especially for open source contributors. Related: PR #243 on
dash-core-components