Sam's attempt at a welcoming CONTRIBUTING file.#278
Conversation
samcunliffe
added
documentation
samcunliffe
requested review from
dstansby,
matt-graham,
mxochicale,
paddyroddy,
ruaridhg and
sfmig
💔 |
paddyroddy
left a comment
paddyroddy
left a comment
There was a problem hiding this comment.
Looks beautiful, but can you wrap to ~80 chars for the README?
CONTRIBUTING.md
Outdated
| [website]: https://github-pages.arc.ucl.ac.uk/python-tooling | ||
| [UCL ARC]: https://ucl.ac.uk/arc | ||
| [open an issue]: https://github.com/UCL-ARC/python-tooling/issues/new/choose | ||
| [Discussions tab]: https://github.com/UCL-ARC/python-tooling/discussions | ||
| [RSE]: https://society-rse.org/about/history |
There was a problem hiding this comment.
Curious as to why this syntax? Always makes me think of RST
There was a problem hiding this comment.
I like it, but literally only because it doesn't interrupt the flow of the text if you read the raw markdown.
So I can write...
We are actively encouraging users to ask questions and start discussions in the
[discussions tab] of this repository. Does something seem like it's broken?
Please go ahead and [open an issue]!
There was a problem hiding this comment.
For example: I would often read raw markdown by cat ing things in the terminal.
There was a problem hiding this comment.
Yeah I like that bit, less a fan of [][]
matt-graham
left a comment
matt-graham
left a comment
There was a problem hiding this comment.
This reads well to me - good balance of getting across key details and being welcoming. Made a few minor suggestions but not strongly wedded to any of them and would be happy for this to go in as is from my perspective.
Co-authored-by: Matt Graham <[email protected]>
|
samcunliffe
force-pushed
the
sc/245-contributing.md
branch
from
8b8b6ad to
d6e33f6
Compare
3 participants
Note
Reviewers:
Please do double-check that what I've written doesn't break the flow of README.md and that I've kept the tone encouraging.