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.

Sign up for GitHub

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

Jump to bottom

docs: document sandbox status & improve docs #140

Merged
merged 7 commits into from
Aug 26, 2024
Merged

docs: document sandbox status & improve docs #140

merged 7 commits into from
Aug 26, 2024

Conversation

idunbarh
Copy link
Member

@idunbarh idunbarh commented Aug 23, 2024 •
edited
Loading

Description

This PR updates the README to ...

  • Reflect bomctl's status as a sandbox project of the OpenSSF
  • Document the commands that are implemented
  • Document similar projects

See the rendered markdown at https://github.com/bomctl/bomctl/tree/sandbox-status

Fixes #115

Type of change

Please delete options that are not relevant.

  • Documentation Updates

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@idunbarh idunbarh requested a review from a team as a code owner August 23, 2024 04:52
jhoward-lm
jhoward-lm approved these changes Aug 24, 2024
View reviewed changes
.gitignore Outdated Show resolved Hide resolved
@idunbarh @jhoward-lm
Update .gitignore
aa2ace0 
Co-authored-by: jhoward-lm <140011346 [email protected]>
Signed-off-by: Ian Dunbar-Hall <100151740 [email protected]>
MFry
MFry reviewed Aug 26, 2024
View reviewed changes
Copy link

@MFry MFry left a comment

Choose a reason for hiding this comment

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

Some small QoL changes

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@idunbarh
feedback from PR #140 comments
bdb64cd 
Signed-off-by: Ian Dunbar-Hall <[email protected]>
@idunbarh idunbarh merged commit 081ef7c into main Aug 26, 2024
9 checks passed
@idunbarh idunbarh deleted the sandbox-status branch August 26, 2024 22:50
pkwiatkowski1 pushed a commit to pkwiatkowski1/bomctl that referenced this pull request Sep 5, 2024
@idunbarh @jhoward-lm @pkwiatkowski1
docs: document sandbox status & improve docs (bomctl#140)
af2873c 
* docs: cleaning up docs and adding openSSF sandbox status to the README.md

Signed-off-by: Ian Dunbar-Hall <[email protected]>

* docs: adding bomctl logo and sandbox status badge

Signed-off-by: Ian Dunbar-Hall <[email protected]>

* docs: adding similar projects

Signed-off-by: Ian Dunbar-Hall <[email protected]>

* adding hoppr to similar projects

Signed-off-by: Ian Dunbar-Hall <[email protected]>

* Update .gitignore

Co-authored-by: jhoward-lm <140011346 [email protected]>
Signed-off-by: Ian Dunbar-Hall <100151740 [email protected]>

* feedback from PR bomctl#140 comments

Signed-off-by: Ian Dunbar-Hall <[email protected]>

---------

Signed-off-by: Ian Dunbar-Hall <[email protected]>
Signed-off-by: Ian Dunbar-Hall <100151740 [email protected]>
Co-authored-by: jhoward-lm <140011346 [email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MFry MFry MFry left review comments

@jhoward-lm jhoward-lm jhoward-lm approved these changes

@ashearin ashearin ashearin approved these changes

@eddiezane eddiezane Awaiting requested review from eddiezane

@ware ware Awaiting requested review from ware

@lmphil lmphil Awaiting requested review from lmphil

@mfrystacky mfrystacky Awaiting requested review from mfrystacky

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Include other similar tools
4 participants
@idunbarh @MFry @ashearin @jhoward-lm