Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 2.93 KB

CONTRIBUTION.md

File metadata and controls

38 lines (31 loc) · 2.93 KB
Raw

Introduction

First off, thank you for considering contributing to this project. It's people like you that make cowin-slots such a great tool!

Contribution Guide

Creating issues

  • Make sure that there are no duplicate issues by first checking the Issues tab
  • 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.

Setup

  • Fork this repo and then clone the forked repo (https://github.com/<your-username>/cowin-slots.git)
  • Run yarn inside the root directory to install all the required dependencies
  • 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.
    • lint: Run prettier across all files
    • test: Run tests using Jest
  • Create an issue branch using this pattern: type/issue-{issue-number} (fe: feat/issue-12, fix/issue-87)
  • After completing your work on the issue, push the changes to your forked repo using git cz