Skip to content

Fix #2528: improve explanation in CONTRIBUTING.md#2548

Merged
josdejong merged 4 commits into
developfrom
fix/extend_contributing
May 9, 2022
Merged

Fix #2528: improve explanation in CONTRIBUTING.md#2548
josdejong merged 4 commits into
developfrom
fix/extend_contributing

Conversation

@josdejong
Copy link
Copy Markdown
Owner

See #2528

@josdejong
Copy link
Copy Markdown
Owner Author

@HanchaiN can you have a look at this improved CONTRIBUTING.md?

@josdejong josdejong mentioned this pull request May 2, 2022
@josdejong
Copy link
Copy Markdown
Owner Author

Thinking about it, maybe it is better to keep CONTRIBUTING.md concise, and put the extensive documentation in README.md instead. Then we can link from CONTRIBUTING.md to these sections in README.md. What do you think?

@HanchaiN
Copy link
Copy Markdown
Contributor

HanchaiN commented May 3, 2022

I think that the description is clear enough for new contributors (else they will raise the issue again sometime).
Whether or not the documentation is seperated depends on you. As long as they can reach the infomation from where they might look for them, that's fine.

@gwhitney
Copy link
Copy Markdown
Collaborator

gwhitney commented May 4, 2022

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.

@josdejong
Copy link
Copy Markdown
Owner Author

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.

@josdejong josdejong merged commit 66ce56b into develop May 9, 2022
@josdejong josdejong deleted the fix/extend_contributing branch May 9, 2022 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants