Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (36 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 1.01 KB

Contributing to vS Vault

Repository Standards

Commit Messages

Use clear, descriptive commit messages:

<type>: <description>

Types:
- feat: New features
- fix: Bug fixes  
- docs: Documentation updates
- style: UI/UX improvements
- refactor: Code improvements
- test: Test additions
- chore: Maintenance tasks

File Organization

  • README.md - Main project overview
  • SECURITY_ANALYSIS.md - Security documentation
  • AUDIT_CHECKLIST.md - Audit preparation
  • DESIGN_SYSTEM.md - UI/UX documentation
  • src/ - Smart contracts
  • frontend/ - React application
  • test/ - Test suites

Pull Request Guidelines

  1. Create feature branch from main
  2. Add comprehensive tests
  3. Update documentation if needed
  4. Use descriptive PR title and description
  5. Request review before merging

Code Quality

  • Follow existing code style
  • Add comments for complex logic
  • Maintain test coverage
  • Keep functions focused and small

Goal: Maintain professional, audit-ready codebase