Contributing to github-original-streak

✨ Thanks for contributing ✨

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Conventions

Pull Request

Address only one use case in one PR.
Ensure test compliance
Keep the PR as short as possible
Write readable code
Avoid confusing one liners

Commit messages

Please follow this commit message convention
If you like to ease the process, you can use commitizen
Please add [ci skip] to the commit messages for documentation only changes

Setup

Fork the repo
Clone your fork
Make a branch for your feature/fix/etc.
Run npm install (make sure you have node and npm installed first)
Run npm run build:watch, it will watch for changes and generate the bundles at chrome/src & firefox/data
Test the extension locally

Navigate to chrome://extensions
Check Developer mode
Click Load unpacked extension
Navigate to local folder
And follow the instruction

Commit the changes, run npm run commit

Follow the instruction displayed in the prompt

Push your branch to your fork
Create a pull request from your branch on your fork to master on this repo.
Get merged! 🎉 🎊