Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 1.54 KB
Raw

Contributing to motion_photos

Here are the guidelines we'd like you to follow:

NOTE:

Never push directly to main repository (upstream). Only push to your forked repo (origin) and send a pull request to the main repository.

Setup

  • Clone the repository 
    git clone <FORK_URL>
  • Enable githooks 
    git config core.hooksPath .githooks

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • The coding style to be followed along with instructions to use flutter_lint
  • Enable Sound-Null-Safety

Git Commit Guidelines

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools.

Example Commit Message

feat(Profile): display QR code

fetch the qr code from API and display it on Profile page (profile_screen.dart)

fixes #1234

Please follow the conventions followed here.

Also, refer this page on how to write the body