docs: add CONTRIBUTING.md with contribution guidelines#83
Open
afurm wants to merge 1 commit intolsdefine:mainfrom
Open
docs: add CONTRIBUTING.md with contribution guidelines#83afurm wants to merge 1 commit intolsdefine:mainfrom
afurm wants to merge 1 commit intolsdefine:mainfrom
Conversation
Addresses issue lsdefine#64: Add CONTRIBUTING.md for open source friendliness - Code style guide (Python 3.11+, 4-space indentation, naming conventions) - Branch strategy (feat/fix/docs/refactor/test prefixes) - Testing requirements (unittest framework, pytest, integration test skip pattern) - Commit message format (type(scope): description) - PR description template with required sections - Issue guidelines (Bug Report, Feature Request, Question templates) - Bilingual EN/CN format matching project style
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.
Summary
Adds a comprehensive CONTRIBUTING.md file to improve open source friendliness, addressing issue #64.
What
Why
Issue #64 identified that the project lacked contribution guidelines, making it harder for external contributors to participate. This CONTRIBUTING.md provides:
The bilingual format (English/Chinese) matches the project's existing documentation style.
Testing
Notes