Contributor guide (Moncy Gopalan)

CONTRIBUTING.md

Project Contributor Guide

Style guide

The codebase adheres to the following style guides and is enforced using ESLINT:

• Airbnb JavaScript

• Airbnb React/JSX

• Airbnb CSS

If possible, please use ESLINT and Prettier plugins/extensions in your editor to get real-time feedback.

Regarding CSS naming convention, BEM is optional since the project uses CSS modules.

Development workflow

The project uses a simplified gitflow workflow. Basically, development mainly takes place in dedicated feature branches which are merged back into the develop branch when finished.

Branch naming convention

Name your branches with prefixes and descriptions: [type]/[change]. Eg. refactor/auth-flow

Acceptable types:

• feature

• bugfix

• update

• cleanup

• refactor

Checklist for pull requests

Any pull request must meet the following base requirements:

• List all changes you have made in the description field.

• Ensure the linter does not report any issues.

• Ensure there are correspoding tests for relevant changes.

• Ensure all CI tests pass.

• Rebase to synchronize your work with the remote develop branch (origin/develop) and ensure all conflicts are fixed before submitting the pull request. Use git pull origin develop && git rebase develop.