-
-
Notifications
You must be signed in to change notification settings - Fork 104
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
Reorganize README for usefulness by user roles #473
Reorganize README for usefulness by user roles #473
Conversation
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 these changes are really helpful! Thank you!!
I only have two thoughts:
- I think the "Code of conduct" section should remain at the top. It is important for issues, comments, etc., not just code submissions.
- I am a little confused at "Project Usage" vs "Manual Usage". I think the sections might benefit from being combined or reorganized.
@briandominick please let me know if you'd like to discuss above two items before this PR is merged, or merge ASAP and follow-up. Either way works for me.
I'll put the code of conduct back up top, and let me figure something out with the "usage" sections and I'll push again if you don't mind keeping this PR open a bit longer. |
Okay, sorry that took so long. The remnants of Debbie did some damage in my yard that I'm still cleaning up, and on top of that I switched laptops and had to get everything up and running on the new workstation. My solve for the "Manual Usage" was just to get rid of that section heading. The original intent was basically "developer usage" vs "user usage" which is not necessary to highlight at that point in the document. |
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.
Thank you!
Fixes
Description
Rearranges the README doc so more technical/tooling/dev-related sections are toward the end, while content intended for "end users" is prioritized after setup instructions.
Also changed a few section headings and transformed sentence-case outliers to title case.
Checklist
Update index.md
).main
ormaster
).visible errors.
Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin