Skip to content

docs: add test contribution guideline#60

Open
Satyam0000000 wants to merge 1 commit into
bug0inc:mainfrom
Satyam0000000:docs/test-contribution-guidelines
Open

docs: add test contribution guideline#60
Satyam0000000 wants to merge 1 commit into
bug0inc:mainfrom
Satyam0000000:docs/test-contribution-guidelines

Conversation

@Satyam0000000

Copy link
Copy Markdown

Problem

The current CONTRIBUTING guide documents branch naming conventions for features, fixes, and documentation changes, along with examples for feat:, fix:, and docs: 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:

test: add unit tests for multi-model assertion consensus

which suggests that test: is an accepted convention, but it is not currently documented.

Changes Made

File Modified

  • CONTRIBUTING.md

Updates

  • Added test/description to the Branch Naming section.
  • Added a test: example to the Commit Messages section.

Suggested Addition

Branch Naming

  • feature/description for new features
  • fix/description for bug fixes
  • docs/description for documentation changes
  • test/description for test-only changes

Commit Messages

feat: add support for custom model providers
fix: handle empty email extraction gracefully
docs: update environment variables table
test: add test contribution naming conventions

Benefit

This change documents an existing convention and helps contributors follow a consistent naming pattern when submitting test-related changes.

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.

1 participant