Skip to content

Conversation

@idunbarh
Copy link
Member

@idunbarh idunbarh commented Aug 23, 2024

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

…E.md

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
@idunbarh idunbarh requested a review from a team as a code owner August 23, 2024 04:52
Co-authored-by: jhoward-lm <140011346+jhoward-lm@users.noreply.github.com>
Signed-off-by: Ian Dunbar-Hall <100151740+idunbarh@users.noreply.github.com>
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

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
@idunbarh idunbarh merged commit 081ef7c into main Aug 26, 2024
@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
* docs: cleaning up docs and adding openSSF sandbox status to the README.md

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>

* docs: adding bomctl logo and sandbox status badge

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>

* docs: adding similar projects

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>

* adding hoppr to similar projects

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>

* Update .gitignore

Co-authored-by: jhoward-lm <140011346+jhoward-lm@users.noreply.github.com>
Signed-off-by: Ian Dunbar-Hall <100151740+idunbarh@users.noreply.github.com>

* feedback from PR bomctl#140 comments

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>

---------

Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
Signed-off-by: Ian Dunbar-Hall <100151740+idunbarh@users.noreply.github.com>
Co-authored-by: jhoward-lm <140011346+jhoward-lm@users.noreply.github.com>
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.

Docs: Include other similar tools

5 participants