Improve issue referencing standards in contributing guidelines (#106) #239
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
…e-org#106) - Updated contributing.rst to fix typo: enthusiatic → enthusiastic - Enhanced writing_good_commit_messages.rst to recommend full GitHub URLs for issue references instead of shorthand (aboutcode-org#123) format - Added guidance on when to use shorthand vs. full URLs: * Shorthand acceptable for commits within same repository * Full URLs required for code comments to prevent broken references when code is moved between repositories This change helps maintain traceability when code and documentation are migrated to different repositories. Fixes aboutcode-org#106 Signed-off-by: Anish <anishkumar@example.com>
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.
Summary
Fixes #106
Updates contributing guidelines to recommend full GitHub URLs for issue references instead of shorthand numbers, preventing broken references when code is moved between repositories.
Changes Made
contributing.rst: "enthusiatic" → "enthusiastic"writing_good_commit_messages.rstto recommend full GitHub URLs (e.g.,https://github.com/aboutcode-org/aboutcode/issues/234) for code comments and cross-repository references#234) is acceptable for commit messages within the same repositoryRationale
When code or documentation is moved to a different repository, shorthand issue references (
#123) will point to a completely different issue in the new repo, breaking traceability. Full URLs remain valid regardless of where the code lives.Testing
Before / After
Before: Contributors were instructed to use
#234for all issue referencesAfter: Contributors are now guided to use full URLs for code comments and cross-repo references, with shorthand accepted for commit messages within the same repository