Development Guideline

Tool and Rules for Developers

Contribution Guide

1. Each feature is one pull request
2. Pull request need contain/link issue number by using this
3. All code which do not obey code style, code lint and format will be rejected.
4. Branch naming: Branch name should follow this format
   • feature/feature_name_or_issue_name_here
   • bug/bug_name_or_issue_name
   • document/update_of_document_here
   • devops/issue_name_or_summary_of_your_work
5. Please fork this repo and add our GitHub as your upstream, don't push direct your code to our repo.

IDE and extensions

Please install following tools and extensions to make sure we have the same configuration

• Editor: I prefer Visual Code
• Code Formatter: We're only use Prettier
• Code Lint: We're only use ESLint
• MongoDB: To help you explore MongoDB MongoDB
• Spell check: To make sure there are no typo Code Spell Check