Skip to content

Latest commit

 

History

History
125 lines (121 loc) · 4.87 KB

CONTRIBUTING.md

File metadata and controls

125 lines (121 loc) · 4.87 KB
Raw

Contribution Guide

Issues
  • Make sure that there are no duplicate issues by first checking the Issues tab and that the issue that you've selected hasn't already been assigned or being worked on.
  • The title should follow the following pattern: [TYPE] <short-description>, where TYPE is one of feat | fix | docs | build | ci/cd
  • Explain, in detail, what the issue is about and if it's a bug, add steps to reproduce it.
Branching
  • When creating branches, please use the following pattern: type/issue-{issue-number} (f.eg.: feat/issue-12, fix/issue-87)
Project Setup
  • Fork this repo and then clone the forked repo (https://github.com/<your-username>/Cowin-Vaccine-Availablity-Checker.git)
  • Run either yarn or npm install inside the root directory to install all the required dependencies(Please make sure to remove duplicate/redundant lockfiles)
  • Scripts
    • start: Run the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.
    • build: Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is ready to be deployed! See the section about deployment for more information.
    • eject:
      Note: this is a one-way operation. Once you eject, you can’t go back!
      If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
    • test:
      1. Start:- Run npm test from root of the project.
      2. Update Snapshots:- To Update all failing snapshots run npm run test:snap from root of the project.
      3. Test Coverage:- To get the test coverage run npm run test:cover from root of the project.
Environment Variables
  • REACT_APP_MAPBOX_ACCESS_TOKEN: TO add this token , Make sure you dont delete the .env.example but make a copy and paste the it the root directory and rename it to .env and paste your token which you will get as you follow the below steps.