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

Add more missed documentation #34

Merged
merged 3 commits into from
Dec 9, 2024
Merged

Add more missed documentation #34

merged 3 commits into from
Dec 9, 2024

Conversation

Hinton
Copy link
Member

@Hinton Hinton commented Dec 9, 2024

๐Ÿ“” Objective

Adds some more documentation that got added in the latest spec draft.

โฐ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

๐Ÿฆฎ Reviewer guidelines

  • ๐Ÿ‘ (:+1:) or similar for great changes
  • ๐Ÿ“ (:memo:) or โ„น๏ธ (:information_source:) for notes or general info
  • โ“ (:question:) for questions
  • ๐Ÿค” (:thinking:) or ๐Ÿ’ญ (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • ๐ŸŽจ (:art:) for suggestions / improvements
  • โŒ (:x:) or โš ๏ธ (:warning:) for more significant problems or concerns needing attention
  • ๐ŸŒฑ (:seedling:) or โ™ป๏ธ (:recycle:) for future improvements or indications of technical debt
  • โ› (:pick:) for minor or nitpick changes

@Hinton Hinton requested a review from dani-garcia December 9, 2024 10:39
Copy link

github-actions bot commented Dec 9, 2024

Logo
Checkmarx One โ€“ Scan Summary & Details โ€“ 3dad39b7-c306-46e8-8c86-100f0f3a3f69

No New Or Fixed Issues Found

@Hinton Hinton merged commit 60bf99f into main Dec 9, 2024
7 checks passed
@Hinton Hinton deleted the more-docs branch December 9, 2024 11:34
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