Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 667 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 667 Bytes

Contributing to EssentialMC2

We appreciate any kinds of contributions, including but not limited to:

  • Fix bugs
  • Add new features and new components
  • Add documentations or correct spelling errors
  • ...

How to contribute

  1. Fork and pull latest EssentialMC2 repo to local
  2. Checkout a new branch,
    • DO NOT use main branch
    • Recommend branch name: bug_fix/xxx for bug fix, feature/xxx for new features and new components, doc/xxx for docs
  3. Commit your changes in new branch to the fork repo
  4. Create a PR in format PULL_REQUEST_TEMPLATE.md

Code style

We follow Google Python Style Guide.