Final part of #230: clarity + the flow of information #265
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
Clean up the flow of information from README → CONTRIBUTING → doc/developers. * Remove repetition of information particularly in developers docs. * Simplify the language in README (with assistance from ChatGPT!) * Move some of the guidelines in CONTRIBUTING into templates for PRs, bug reports and feature requests and then just reference the templates. * Other grammar and consistency tweaks.
samcunliffe
added
documentation
samcunliffe
commented
Apr 20, 2023
samcunliffe
commented
Apr 20, 2023
willGraham01
approved these changes
Apr 21, 2023
There was a problem hiding this comment.
One actual consideration re:MATLAB + Doxygen; the rest are grammar things (although my grammar is terrible so you're welcome to reject them).
Closed
samcunliffe
commented
Apr 21, 2023
Tweaks, clarity, and avoid repeating words and clarity. Co-authored-by: Will Graham <32364977+willGraham01@users.noreply.github.com>
samcunliffe
commented
Apr 21, 2023
| about: Create a report to help us improve | ||
| title: '' | ||
| labels: 'bug' | ||
| assignees: '' |
There was a problem hiding this comment.
So also to note: we could add a default assignee here. I opted not to because I get notifications for all activity (so critical bugs shouldn't go under the radar).
We can set this up for Peter at handover too.
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.
Cleans up the flow of information between...
README → CONTRIBUTING → doc/developers.
And simplify README (which is also the new landing page home since #231).
Dependencies
Changes:
reports and feature requests and then just reference the templates.
Reviewer notes
Picky comments about clarity are very welcome.
Presumably, some of the changes in the chain of #236 .. #262 will mean bits of this become obsolete. But I try to document how things are on the current
main.