CONTRIBUTING.md

🦄 Contributing to gitmoji-browser-extension

Hello! 👋

Thanks for contributing on gitmoji-browser-extension. Before implementing new features and changes, feel free to submit an issue. We're going to talk here 😜.

This project uses Svelte to create the interface and is build using Parceljs.

🌱 How to submit a pull request?

1. Fork this repository.
2. Create a new feature branch. (Eg: feature/improve-footer-design)
3. Make your changes.
4. Make a little check using yarn lint && yarn test
5. Commit your changes using the gitmoji convention.
6. Submit your pull request.

🔨 How to start gitmoji-browser-extension locally

If you want to make changes to the site, follow the next steps:

1. Clone the project

git clone https://github.com/johannchopin/gitmoji-browser-extension.git
cd gitmoji-browser-extension

2. Install the dependencies and start the development task.

yarn install && yarn start

The development task will compile, watch and open the extension in a sandbox webpage. Your are ready to make your changes 👍

🚀 Build gitmoji-browser-extension

1. Build the extension to test it in your browser

yarn watch

It will compile and watch the extension under the dist/ folder. Just load this folder has an unpacked extension in your browser:

• in Firefox : Temporary installation in Firefox
• in Chrome : See point 1 of Create the manifest step
• in Microsoft Edge: Same process than for Chrome

2. Build the extension

yarn build

It will create the extension as a zip file called extension.zip in the root of the project.

---

Made with ❤ by @johannchopin and @lyokolux