Skip to content
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

Merged
merged 6 commits into from
Aug 22, 2024

Conversation

briandominick
Copy link
Contributor

@briandominick briandominick commented Jul 25, 2024

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

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    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
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@briandominick briandominick requested review from a team as code owners July 25, 2024 14:18
@briandominick briandominick requested review from Shafiya-Heena and possumbilities and removed request for a team July 25, 2024 14:18
@TimidRobot TimidRobot self-assigned this Aug 7, 2024
Copy link
Member

@TimidRobot TimidRobot left a 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:

  1. I think the "Code of conduct" section should remain at the top. It is important for issues, comments, etc., not just code submissions.
  2. 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.

@briandominick
Copy link
Contributor Author

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.

@briandominick
Copy link
Contributor Author

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.

Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@TimidRobot TimidRobot merged commit 8f92651 into creativecommons:main Aug 22, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Reorganize the README for user-friendliness
2 participants