[MISC] improve docs on how to contrib in README#275
[MISC] improve docs on how to contrib in README#275sappelhoff wants to merge 2 commits intobids-standard:masterfrom
Conversation
effigies
left a comment
There was a problem hiding this comment.
This LGTM. A couple suggestions for helping people plug in effectively.
Co-Authored-By: Chris Markiewicz <effigies@gmail.com>
|
|
||
| If you want to become a part of the BIDS community and contribute to the specification, please see our | ||
| [contributing guidelines](./CONTRIBUTING.md). | ||
| # Contributing to BIDS |
There was a problem hiding this comment.
I feel like this section is mixing a README and a CONTRIBUTING guide. Here's an example of how I'd think about this section, with specific suggestions below 👇
| # Contributing to BIDS | |
| # Contributing to BIDS | |
| BIDS is a community-driven standard, and it depends on contributions from its users. | |
| We :yellow_heart: new contributors, and we appreciate all contributions to the project! | |
| To see a current list of our contributors, please see our [Contributors appendix](https://github.com/bids-standard/bids-specification/blob/master/src/99-appendices/01-contributors.md). | |
| When you're ready to get started, check out [our contributing guidelines](https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md). | |
| Want to learn more about working with BIDS? Have a question, comment, or suggestion? | |
| Open or comment on one of our [NeuroStars issues](https://neurostars.org/tags/bids)! | |
| We ask that all contributors to BIDS across all project-related spaces (including but not limited to: | |
| GitHub, the [Google group](https://groups.google.com/forum/#!forum/bids-discussion), and newsletter emails), | |
| adhere to our [code of conduct](https://github.com/bids-standard/bids-specification/blob/master/CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
Line 14 of @emdupre proposal - (users -> members)
| # Contributing to BIDS | |
| BIDS is a community-driven standard, and it depends on contributions from its members. |
|
Thanks for thinking on this, @franklin-feingold and @sappelhoff ! I think about the division between a README and CONTRIBUTING a little differently, I suppose, so I've made one suggested re-write above. Would be curious to know what you think ! |
| [contributing guidelines](./CONTRIBUTING.md). | ||
| # Contributing to BIDS | ||
|
|
||
| BIDS is a community-driven standard and it depends on contributions from its |
There was a problem hiding this comment.
this paragraph referenced in my comment
|
I think both are good and have great qualities! Thank you @emdupre and @sappelhoff ! I think merging together by keeping the suggestion from Elizabeth and removing the first paragraph under the suggestion but keeping the places where discussions are happening. I denoted in the comments the first paragraph that can be removed. Perhaps drawing attention to the starter kit/tutorials to help newer members get started as well? |
|
Going over this again and with @emdupre's comment in mind, I agree that what I proposed is what would rather belong to the contributor's guide ... 🤔 What if I add my content to the contributors guide ... and in the README just make a more prominent link to the contributors guide? (and with contributor's guide, I mean In the README it could just say (rough example): |
|
To clarify - your proposed language in the What were you thinking of adding to the contributor guide? The details of the discussion channels can be good in the contributing guide. |
|
I would add a lot of the content of my original contribution NOT to the README anymore ... but instead weave it into the existing contributor's guide (CONTRIBUTING.md). and then in the README, we have currently this sentence:
I would make that sentence a bit more visible with its own heading --> then this PR would
and hopefully this would be a good step towards adressing the initial issue: Ease navigation for fresh contributors and draw attention to pinned and tagged issues and PRs |
|
I think I'd still like to see some expanded text in the README -- what I sketched out above 👆 make sense to me, but obviously curious on your thoughts ! Otherwise, I definitely agree we should also add any information we're not putting in the README into the contributing guide. Could that be this same PR ? I can also make a pass at it myself, just to show what I'm thinking if that's useful ! EDIT: Opened #279 😸 |
|
closed by #279 |
alternative suggestion to #273
supersedes and closes #273 if merged
If we agree with this, we can also start pinning the most important issues.
Rendered: https://github.com/bids-standard/bids-specification/blob/9efdd5d7fbfcefa6d6805b12894c19e52ce0f190/README.md