-
Notifications
You must be signed in to change notification settings - Fork 40
Add contributing guidelines and update README #278
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 5.x
Are you sure you want to change the base?
Conversation
RCheesley
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quite a few suggestions but they should be quick to fix. Thanks for working on this @adiati98 and no rush!
|
@RCheesley thanks so much for the suggestion! I'll apply them soon and let you know when they're ready. 👍🏼 In the meantime, I'd like to explain why I do below details across our docs:
AdmonitionsApplying GitHub admonitions for notes, tip, or warnings as part of the list does:
Here are some screenshot of examples: 1. Admonition as part of unordered listAs you can see, the admonition is out of the flow.
2. Admonition as part of ordered listImage 1Just like the example in unordered list, the admonition is out of the flow.
Image 2After the admonition, all instructions are still belong to point 4. But the indentation follows the admonition instead of the point. This can cause confusions.
Image 3For this one, I indent the admonition just like we indent a paragraph that's part of a point. The indentation works great, but the admonition breaks.
The
|
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
… having a note in the middle of the list
This reverts commit 41c0ae0.
RCheesley
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small suggestions!
.github/CONTRIBUTING.md
Outdated
|
|
||
| If you're ready to push your changes to the remote repository and create a PR, please read the "[Push changes to the remote repository](#push-changes-to-the-remote-repository)" and "[Create a PR](#create-a-pr)" sections. | ||
| ### 3. Local development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would probs put the working locally section first then have the codespaces as an 'if you can't work locally, use this' option.
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
|
@RCheesley TIL that we can wrap one point of order list with vale and it doesn't break it as in RST. 💡 Here's the preview for this PR: |




Description
This PR holds below changes:
.githubfolder.Linked issue
Closes #272
Closes #279
Screenshots or screen recordings