Add contributing guide. #2846
Add contributing guide. #2846
Conversation
SergioBenitez
force-pushed
the
contributing-guide
branch
3 times, most recently
from
856f8ed to
607602c
Compare
| To propose a new feature, create a [new issue] and select "feature request." | ||
| Follow the template, describing your solution in the _ideal solution_ or | ||
| _additional context_ sections as appropriate. Note that certain classes of | ||
| features require strong justification and exceedingly compelling reasons in | ||
| order to be taken into consideration. These include features that: |
There was a problem hiding this comment.
I think we should reword this, and provide more detail on what we want from a feature request (most of this is about what not suggest).
Some things I would look for in a feature request:
- Clear issue it's solving (e.g., A would now be possible, or A was very hard, but is now much easier)
- Code examples for what someone using the new feature would look like (and the current work around if relevant)
- Cohesive design
- Limits potential for confusion and foot guns
- As simple as possible (from the perspective of someone using Rocket)
There was a problem hiding this comment.
The feature request issue template already has fields for most of these. Do you think it doesn't suffice?
There was a problem hiding this comment.
It's been a little while since I've opened an issue, so I had to go re-read it. Although I think it covers what we want, I do think there is some value of repeating it here.
Alternatively, we could shorten this section a bit, and simply refer to the issue creation for both what we are, and are not looking for.
|
Reworked a bit of stuff based on your feedback. Let me know what you think. |
|
My main takeaway from the conversation, this time, is that we need a development guide at some point. Other than that, I just left one comment open. After addressing that (and fixing CI :)), I think we are good to merge. |
|
The CI issues were unrelated and fixed on master. We definitely need a development guide at some point, but it's a big undertaking. As far as being more specific about new features, what would you suggest, more specifically? Do you think we should improve the issue template and defer to it, add more wording here, or some combination thereof? |
SergioBenitez
force-pushed
the
contributing-guide
branch
from
ede7447 to
3e881f2
Compare
|
Merged. |
Adds a new
CONTRIBUTING.mdand modifies the README accordingly.@the10thWiz curious to get your thoughts on this.
CONTRIBUTING rendered.
README rendered.