CONTRIBUTING.md

Contributing to GitStory

Code Structure

• index.ts : Every public function available to use when instanciating a new GitStory class
• clients/* : Individual files that contains the actual logic for every supported Git platform
• tests/* : A tests directory that you can use to test your functions using npn run test

Commands

Install packages

$ npm i

Run Unit Tests

$ npm run test

Submitting Contributions

This project follows GitHub's standard forking model. Please fork the project to submit pull requests.

Submitting a feature/bugfix to the project

• Create Issue with tag enhancement or bug
• Fork the repository
• Clone your fork locally
• Create a new branch and make your commits
• Push your commits to your forked repo
• Make a Pull request
• Request will be added after review