CONTRIBUTING.md

Setting Up the project locally

To install the project you need to have yarn and node

1. Fork the project, clone your fork:

   # Clone your fork
   git clone https://github.com/<your-username>/re-promise.git
   
   # Navigate to the newly cloned directory
   cd re-promise
   

2. npm to install dependencies

3. npm run build to build the UMD and ES bundle of the app

Tip: Keep your master branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/vivek12345/re-promise.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Submitting a Pull Request

Please go through existing issues and pull requests to check if somebody else is already working on it, we use someone working on it label to mark such issues.

Also, make sure to run the tests and lint the code before you commit your changes.

npm run test
npm run lint

Add yourself as a contributor

This project follows the all-contributors specification. Contributions of any kind welcome!

To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

npm run add-contributor

Follow the prompt and commit .all-contributorsrc and README.md in the PR.

Thank you for taking the time to contribute! 👍