When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Clone the repository to your machine :
git clone https://github.com/AmitGujar/Bink-Chrome-Extension
- Enable Extensions Developer Mode on Google Chrome/Microsoft Edge.
- Navigate to chrome://extensions/ or edge://extensions.
- Enable developer mode (Toggle button in right top corner).
- Select
Load Unpacked
and browse and select the cloned repository folder. - Make sure that the extension is enabled.
- Open a new tab in Chrome and you should see a splash screen with motivational quotes.
- Microsoft Edge disables all-new tab extensions by default so, make sure to enable it manually from the extensions section.
- Ensure your code compiles. Run
make
before creating the pull request. - If you're adding new external API, it must be properly documented.
- The commit message is formatted as follows:
component: <summary>
A paragraph explaining the problem and its context.
Another one explaining how you solved that.
<link to the bug ticket>
- You may merge the pull request in once you have the sign-off of the maintainers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
- "Bug": Something that should work is broken
- "Enhancement": AKA feature request - adds new functionality
- "Hacktoberfest": Part of hacktoberfest program
- "Task": Something that needs to be done that doesn't really fix anything or add major functionality. Tests, engineering, documentation, etc.