Contributing to Minchyn Codebase

Getting Started with Contributions: #

Before contributing, read the Developer Setup Guide to configure your environment. Review the Engineering Standards document to understand code quality expectations. Join the #engineering Slack channel for communication with the team. Pick issues tagged ‘good first issue’ for initial contributions. Fork the repository and create a feature branch from main: git checkout -b feature/your-feature-name. Make commits with descriptive messages following conventional commits: feat:, fix:, docs:, refactor:. Keep commits atomic and focused on single changes. Push your branch and open a pull request with clear description of changes and motivation.

Code Review Process: #

All code must pass automated checks before review: ESLint for code quality, TypeScript compilation, Jest tests, and build verification. Pull requests require approval from at least one team member before merging. Reviewers check for: correctness, performance implications, test coverage, documentation updates, adherence to patterns. Address feedback promptly with commits or comments. Use ‘Resolve conversation’ only after changes are made. Large PRs should be split into smaller, reviewable chunks. Avoid force-pushing after review starts–use regular commits for traceability. Once approved, squash and merge to keep main history clean.

Best Practices for Quality Contributions: #

Write self-documenting code with clear variable names and function purposes. Add comments for complex logic or non-obvious decisions. Include JSDoc comments for public functions and components. Write tests for new features and bug fixes–PRs without tests may be rejected. Update documentation when adding features or changing APIs. Check for existing patterns before introducing new approaches. Optimize for readability over cleverness. Avoid breaking changes to public APIs without discussion. Use feature flags for large changes to enable gradual rollout. Refactor opportunistically: improve code you touch, but keep refactoring separate from feature work. Celebrate contributions: we value every improvement to the platform.