Sam's attempt at a welcoming CONTRIBUTING file. #278
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samcunliffe
added
documentation
samcunliffe
requested review from
dstansby,
matt-graham,
mxochicale,
paddyroddy,
ruaridhg and
sfmig
samcunliffe
commented
Jan 23, 2024
💔 |
paddyroddy
requested changes
Jan 23, 2024
CONTRIBUTING.md
Outdated
Comment on lines
33
to
37
| [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
approved these changes
Jan 23, 2024
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
|
samcunliffe
force-pushed
the
sc/245-contributing.md
branch
from
8b8b6ad to
d6e33f6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.