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

chore: readme and contributing guide updates #418

Merged
merged 5 commits into from
Feb 9, 2024

Conversation

kevin-orlando
Copy link
Contributor

@kevin-orlando kevin-orlando commented Jan 31, 2024

secureli-396

closes #396

General updates and clean up to readme and contributing guides.

Changes

  • Updated README.md
  • Updated CONTRIBUTING.md

Testing

N/A

Clean Code Checklist

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

@kevin-orlando kevin-orlando changed the title readme and contributing guide updates chore: readme and contributing guide updates Jan 31, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

PR title failed to match (chore|style|test|feat|fix|docs|ci): .+

@kevin-orlando kevin-orlando merged commit 2ab23c1 into main Feb 9, 2024
5 checks passed
@kevin-orlando kevin-orlando deleted the feature/secureli-396-documentation-audit branch February 9, 2024 17:44
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.

Audit documentation for accuracy & completeness
2 participants