Contributing to Nomey®

Instructions for contributing to Nomey®, including code standards, pull requests, and issue reporting.

Code Standards

We follow a few key standards to maintain code quality:

• TypeScript: All code should be strongly typed. Use of any is forbidden.
• Linting & Prettier: We use Husky pre-commit hooks to enforce linting / formatting rules.
• Commit Messages: Use conventional commits for clarity. Example: feat: add new reel upload feature.
• Branch Naming: Use descriptive names like feature/reel-upload or bugfix/login-error.
• Testing: Write unit tests for new features and bug fixes. Use Vitest for testing.

Pull Requests

When you’re ready to submit your changes:

1. Create a Pull Request (PR): Open a PR against the main branch.
2. PR Title: Use a clear, descriptive title.
3. PR Description: Explain what your changes do, why they are needed, and any relevant context.
4. Accompanying Materials: Attach screenshots, Loom videos, or other materials to help reviewers understand your changes.
5. Instructions: If your PR requires specific testing steps, include them in the description.
6. Review Process: PRs will be reviewed by at least one team member. Address any feedback promptly