Fix #2528: improve explanation in CONTRIBUTING.md#2548
Conversation
|
@HanchaiN can you have a look at this improved CONTRIBUTING.md? |
|
Thinking about it, maybe it is better to keep |
|
I think that the description is clear enough for new contributors (else they will raise the issue again sometime). |
|
For what it's worth, the new CONTRIBUTING in this PR seems clear enough but not too long. I would recommend (as part of this PR) mentioning the CONTRIBUTING guide in the README, though -- not all potential contributors look at the whole file tree (speaking from experience), but I think it's pretty common to at least read the README. |
…d a small FAQ section to CONTRIBUTING.md to keep it short
|
I've moved the explanation on implementing a new function to the README, and add a small FAQ section to CONTRIBUTING.md linking to this section to keep it short. I'll merge this PR now, thanks for the feedback. |
See #2528