Contributions are always welcome, no matter how large or small!🙂
- In order to contribute, you need to have Git (a version control software) installed in your machine.
- Refer this 👉 https://docs.github.com/en/github/getting-started-with-github/set-up-git#setting-up-git to install and setup Git 🚀.
-
Fork this repository using the button in the top-right corner of the page. Refer https://docs.github.com/en/github/getting-started-with-github/fork-a-repo for more details.
-
Having forked the repository, clone the repository to your local machine using the below command in the terminal :
git clone https://github.com/YOUR-GITHUB-USERNAME/TabuRei
- Having cloned the copy to your local machine, enter into the
TabuReidirectory using thecdcommand.
cd TabuRei
- Great, you are now present in the source code of the project. You can take a look at the contents of the project using the
lscommand.
ls
You can choose to execute things in 2 ways:
- Head to
about:debugging. - Click on
This Firefoxon top left. - Click on
Load Temporary Add-on - Select
manifest.jsonfile in the extension's directory.
- Head to
chrome://extensions. - Enable
Developer Modeon the top-right. - Click on
Load Unpacked. - Select the extension's directory or any file inside it.
web-ext is a command line tool designed to speed up various parts of the extension development process, making development faster and easier. Installation
npm install --global web-ext
Requires node.js install
Simply execute
web-ext run
This will load your extension into a test web browser and then you can experiment with your changes.
To know more about web-ext, Checkout:
Having setup the project and tested its working, if you want to contribute to it, follow the steps below :
- Make a new branch of the project using the
git checkoutcommand :
git checkout -b "Name-of-the-branch"
-
Make changes according to the issues. Test the working of the changes.
-
Add the changes to staging area using the
git addcommand :
git add .
- Commit the changes made using the
git commitcommad :
git commit -m "Commit-message"
- Push the changes to your branch on Github using the
git pushcommand :
git push -u origin "Name-of-the-branch-from-step-1"
- Then, go to your forked repository and make a Pull Request 🎉. Refer this for more details.
- Egghead Course on How to Contribute to an Open Source Project on GitHub by Kent C. Dodds.
- Learn Git by Codecademy
- Github Learning Lab