Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 1.54 KB

Contributing

  • Assign an issue to yourself before working on it. You should create an issue before starting to work on anything
  • Fork the repository; this means you will have a copy of the repository under your-GitHub-username/repository-name.
  • Clone the repository to your local machine using git clone https://github.com/github-username/repository-name.git.
  • Create a branch against the main branch
  • Commit messages to be prefixed by feat, fix, chore etc. Refer to Conventional Commits specification
  • Create a PR to main. Pull Requests must pass the following checks;
    • Must be approved by a code owner
    • Must pass all CI Checks
    • Must include updated tests
    • Must have every conversation resolved before merging
  • We encourage you to use git rebase for a linear history

Dart conventions

  • Library, package, directory, and file names should be in lowercase_with_underscores.
  • Type names (i.e. classes, typedefs, enum types) should be in UpperCamelCase
  • You should name methods in camelCase.
  • There should be only one public class per file

For more Dart conventions, refer to the Effective Dart guide

Other / House-keeping

  • Dependencies should be ordered alphabetically
  • Format files before opening a PR - flutter format .
  • Run static analysis before opening a PR