Skip to content

Latest commit

History

History
47 lines (30 loc) 路 1.1 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) 路 1.1 KB

Contributing

馃憤馃帀 First off, thanks for taking the time to contribute! 馃帀馃憤

When contributing to this repository, please first discuss the change you wish to make via issue before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

General Guidelines

  • If adding a new feature, write the corresponding test
  • Ensure that nothing get broke. You can use the example for that
  • If applicable, update the documentation
  • Use prettier before commiting 馃槶
  • When solving a bug, please provide the steps to reproduce it(codesandbox is our best friend for that)
  • Tchill 馃憣

Setup

Pre-requisites

  • Node: ^14.0.0
  • Yarn

Install

Clone the repository and create a local branch:

git clone https://github.com/fkhadra/react-contexify.git
cd react-contexify

git checkout -b my-branch

Install dependencies:

yarn install

Project structure

TO COMPLETE

License

By contributing, you agree that your contributions will be licensed under its MIT License.