Adding contributing.md first draft #48
Conversation
|
Let's get @lbrendanl and @jdomingu to weigh in too. I like this. Would be good to add something like "If you are considering adding a new feature, we suggest starting a conversation about it first to identify any potential design or scheduling issues before jumping in." |
|
Would it be worth just briefly mentioning that issues and feature requests are done through GH issues and all other fixes are done through PRs? I don't think it's uncommon for some to be unfamiliar with GitHub so it may be worth calling out. |
Based on feedback from @lbrendanl
|
Looks good to me |
|
@benlower I just saw your second comment about starting a conversation. I'll add something and send a new update real quick. |
based on feedback from @benlower
|
nice |
| @@ -27,3 +27,7 @@ the limitations that you are running into, and provide us with a use case to kno | |||
|
|
|||
| For all other things, please submit a PR that includes the fix, documentation, or new code that you are trying to contribute. More information on | |||
| creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/) | |||
|
|
|||
| If the feature is complex or has multiple solutions that could be equally appropriate approaches, it would be helpful to file an issue to discuss the | |||
| design trade-offs of each solution before implementing, to allow us to collective arrive at the best solution, which most likely exists in the middle | |||
|
yeah, I english good. Thanks @t8y8, fixed |
|
Anymore feedback on this one? Or is it good to merge? |
|
Ship it! |
|
LGTM |
Fixes #41
First draft of the contributing.md. Please feel free to comment on wording, improvements, etc.