-
Notifications
You must be signed in to change notification settings - Fork 4
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
Minor improvements to CI page #335
Conversation
dstansby
commented
Mar 25, 2024
- Don't put an acronym in table of contents
- Note that GH Actions also available for private repos for free
- Link to testing page for test coverage collection recommendation
- Add a details box explaining why there are two 🟢 coverage hosting tools
@@ -15,19 +15,21 @@ layout: default | |||
|
|||
<details> | |||
<summary> 🟢 explanation</summary> | |||
We have many projects using github CI, it's both convenient and works well. It's become the standard. Also, note that it's free for public repos. | |||
We have many projects using GitHub CI and, it has good integration with GitHub itself, and is free for public repositories (with limited free monthly minutes for private repositories). |
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.
Seeing as this is the first time we are using CI, should we define it?
We have many projects using GitHub CI and, it has good integration with GitHub itself, and is free for public repositories (with limited free monthly minutes for private repositories). | |
We have many projects using GitHub continuous integration (CI) and, it has good integration with GitHub itself, and is free for public repositories (with limited free monthly minutes for private repositories). |
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.
Would be nice if this page could be wrapped to 80 chars, in keeping with other pages
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 think if we want to enforce wrap to 80 it would be best to do via a pre-commit hook instead of having to manually edit?
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.
Thanks for catching the acronym - I edited the title of this section instead since CI is such a common acronym.
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.
Sure, it's slightly tricky though as links can go over - and tables. I like markdownlint.
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.
For wrapping I opened a new issue at #337
Co-authored-by: Sam Cunliffe <[email protected]>