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

Update readme with required sections #686

Merged
merged 4 commits into from
Oct 9, 2024

Conversation

semioticrobotic
Copy link
Contributor

This pull request adds a few new sections to the project README. It does so primarily to test automations associated with the DCO bot.

@semioticrobotic semioticrobotic force-pushed the semioticrobotic-readme-patch branch from 7472177 to 5742c6f Compare October 8, 2024 21:16
Signed-off-by: Bryan Behrenshausen <[email protected]>
@semioticrobotic semioticrobotic force-pushed the semioticrobotic-readme-patch branch from 5742c6f to 432787f Compare October 8, 2024 21:17
@semioticrobotic
Copy link
Contributor Author

Nothing urgent here, @gsmith-sas, but since this PR does actually add a few sections and specifications to the README, I wanted to give you the opportunity to have a look.

@semioticrobotic semioticrobotic added the documentation Improvements or additions to documentation label Oct 8, 2024
Copy link
Member

@gsmith-sas gsmith-sas left a comment

Choose a reason for hiding this comment

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

Rather than move the links to the project's documentation to a separate Additional resources section, I'd like to keep it with the project info (now under the Overview section). We moved virtually all of the project's documentation to the Help Center and want to make sure users know where to find it.

So, I'm asking that we move the new Contributing and License sections to after the proposed Additional resources section an remove the Additional resources section header.

@semioticrobotic
Copy link
Contributor Author

Sure thing, @gsmith-sas. Makes sense to me.

Copy link
Member

@gsmith-sas gsmith-sas left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. LGTM.

@semioticrobotic semioticrobotic merged commit 3a5d64a into main Oct 9, 2024
2 checks passed
@gsmith-sas gsmith-sas deleted the semioticrobotic-readme-patch branch October 11, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants