- CLAUDE.md: universal development guidelines - README.md: project description (consistent template) - CONTRIBUTING.md: contribution workflow - CHANGELOG.md: version history Co-Authored-By: Svrnty Inc. <eng@svrnty.com>
1.0 KiB
1.0 KiB
Contributing
Thank you for your interest in contributing to this project.
Development Guidelines
See CLAUDE.md for development practices, engineering principles, and coding standards.
How to Contribute
-
Fork & Clone
git clone <your-fork-url> cd <project> git checkout JP -
Create a Branch
git checkout -b feature/your-feature-name -
Make Changes
- Follow the guidelines in CLAUDE.md
- Keep changes focused and minimal
- Write tests if applicable
-
Validate
- Run format checks
- Run lint checks
- Run test suite
-
Commit
git commit -m "feat: your change description"AI-authored commits must include:
Co-Authored-By: Svrnty Inc. <eng@svrnty.com> -
Push & Create PR
git push origin feature/your-feature-name- Open a PR against the
JPbranch - Provide clear description of changes
- Open a PR against the
Questions?
Open an issue for questions or discussions.