feat: add logging conventions #14
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
I'm not really sure about the design of the good and bad examples. Do you have an idea @ItsKev ? |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive logging conventions documentation to help developers write clear, consistent, and incident-ready logs across the Grounds organization.
Changes:
- Added new logging conventions documentation file with detailed guidelines and examples
- Integrated the new documentation into the Contributing section of the docs navigation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs.json | Added logging-conventions to the Contributing tab navigation |
| contributing/logging-conventions.mdx | New comprehensive logging guidelines covering best practices, examples, log levels, security considerations, and a quick checklist |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
Type of Change
Related Issues
None
Testing
Checklist