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

docs: Added info on repo-config.yaml and tables of contents #562

Merged
merged 5 commits into from
Jun 13, 2024

Conversation

itoltz
Copy link
Contributor

@itoltz itoltz commented Jun 6, 2024

secureli-397

Issue was for adding documentation about config files. There wasn't much more that needed to be added in that regard. I also added tables of contents to README.md and CONTRIBUTING.md. The tables of contents were generated with the VSCode plugin Markdown All in One.

Changes

  • Added section describing the nature of repo-config.yaml
  • Added tables of contents to README.md and 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

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): .+

@itoltz itoltz changed the title Added info on repo-config.yaml and tables of contents docs: Added info on repo-config.yaml and tables of contents Jun 6, 2024
@github-actions github-actions bot dismissed their stale review June 6, 2024 18:28

All good!

@itoltz itoltz merged commit 587deec into main Jun 13, 2024
5 checks passed
@itoltz itoltz deleted the feature/secureli-397-document-config-file-usage branch June 13, 2024 17:08
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.

2 participants