Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1009 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1009 Bytes

Contributing Guide

Thank you for considering contributing to this repository!

Please note that by participating, you are expected to uphold the Contributor Covenant Code of Conduct.

We're currently interested in covering all the available endpoints.

Setting up local environment

fork the repo

clone

git clone https://github.com/yourusername/github-api.git

install dependencies

yarn

or

npm i

IDE

We recommend using the ESLint and Prettier extensions with VSCode (or alternative editor of your preference)
In case if your system is unresponsive (disable ESLint)

Committing

We encourage you to follow Conventional Commits.

Making PR

You'll have to pass Lint
Run yarn lint after making changes to know whether it'll break or not

Chears..!