Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Latest commit

 

History

History
111 lines (88 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

111 lines (88 loc) · 3.14 KB
Raw

Contribution Guidelines

We are very excited to receive active contribution for this project. However, for the sake of smooth development there are some rules and guidelines to be followed. Contributions can be of two kinds features and bug fixes.

Before attempting to add features or fixing bugs, please ensure that issues with the respective labels have been added. Features or bug fixes without issues will definitely not be merged with the main branch.

Forking Workflow

Fork Workflow

A forking workflow has been implemented. Except the core dev team, writing to the main repo has been blocked.

  1. Create a fork to the main repo and add the upstream github url to the list of remote urls.
git remote add <link-to-upstream>
  1. Branch out to a feat/<[Issue ID]-feature-name> or fix/[Issue ID]-fix-name branch. Example:
git checkout -b feat/#824-important-feature
  1. Ensure that you are up to date with the main repo.
git checkout main
git fetch upstream
git merge upstream/main

If you are confident with rebasing:

git rebase main

  1. Create a pull request with the naming format [WIP/RDY] #[Issue ID] - [Small description]. If the pull request is not ready for merge, prepend the pull request name with WIP else add RDY. Please focus on releasing PRs early to prevent others from creating duplicate PRs.

  2. PRs should merge your feature or fix branch with the main branch.

feat/* -> main
  1. Please run lints and tests before making a PR. It is very annoying for us to review failed PRs. Questions as to why lints are failing will not be answered.
TBC

Feature

Feature branches focus on feature requests. Please note that feature requests should be made in the form of issues and not PRs. Feature requests are open to the public. One can work on their own feature requests. As a matter of fact we promote such an activity.

A feature should preferably come with jest test cases that are tested to pass. Please refer to testing.

Bug fixes

Bug fixes dont have a special implementation work. Please reference the bug you are fixing. We appreciate that you took the time to fix our bugs.

Local Development Environment

In order to setup the local server one must install node, docker and docker-compose. Windows users please use WSL. Docker is much faster on WSL.

Frontend Development

  1. Change directory to frontend.
cd frontend
  1. Install dependencies.
npm install
  1. Run dev server.
npm run start

Live reload is enabled by default. Allows changes to be implemented immediately. Access frontend at http://localhost:3000

Backend development

  1. Change directory to backend
cd backend
  1. Run the docker compose dev server
POSTGRES_PASSWORD=postgres POSTGRES_USER=postgres POSTGRES_DB=database docker-compose up --build

Database environment variables POSTGRES_PASSWORD, POSTGRES_USER and POSTGRES_DB need to be set prior the docker build.

The dev server can be accessed at http://localhost:5000.

Deployment

TBC

Testing

TBC