docs: add test contribution guideline#60
Open
Satyam0000000 wants to merge 1 commit into
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
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.
Problem
The current CONTRIBUTING guide documents branch naming conventions for features, fixes, and documentation changes, along with examples for
feat:,fix:, anddocs:commit messages.However, there is no guidance for test-only contributions. While preparing a test-related PR, it was unclear which branch naming pattern and commit prefix should be used.
A previously merged PR (#13) uses the commit/PR prefix:
which suggests that
test:is an accepted convention, but it is not currently documented.Changes Made
File Modified
CONTRIBUTING.mdUpdates
test/descriptionto the Branch Naming section.test:example to the Commit Messages section.Suggested Addition
Branch Naming
feature/descriptionfor new featuresfix/descriptionfor bug fixesdocs/descriptionfor documentation changestest/descriptionfor test-only changesCommit Messages
Benefit
This change documents an existing convention and helps contributors follow a consistent naming pattern when submitting test-related changes.