Create src.instructions.md with commenting rules #2964
Merged
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
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://blue-river-093197403-2964.westeurope.5.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://blue-river-093197403-2964.westeurope.5.azurestaticapps.net |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request adds a new instructions file that defines general rules for commenting code within the
srcdirectory. The file outlines best practices for writing comments, emphasizing that comments should not restate code and should only be used when the code cannot express the intent clearly.Documentation and code quality guidelines:
.github/instructions/src.instructions.mdto specify general rules for code comments, including when to use comments and when to improve code to make comments unnecessary.