CONTRIBUTING.md

🪛 Want to contribute?

We would love for you to join us!

• BookMark🔖 is an open-source project, and we are excited to hear your thoughts and ideas.
• Fork this repository, add your contributions, and submit a pull request (PR).
• Have you found a bug, an accessibility issue, or do you want to add a new feature? Go right ahead and create an issue.

🛠️ Tech Stack

This project uses:

Prerequisites

Before installation, you need to have installed/knowledge of the following:

This Extension is not yet published on the Chrome Web Store

To Test/contribute to this extension, follow the steps below:

How to contribute to this Extension from the Repository

1. Fork the repository (Click the Fork button in the top right of this page, click your Profile Image)
2. Clone the forked repository to your local machine.

git clone https://github.com/your-username/BookMark.git

3. change the present working directory

cd BookMark

4. Open Google Chrome browser and click on the three dots on the upper right side of the browser. Then go to More Tools and click on Extensions as shown below:

5. then you can see a developer mode switch on the right upper side of the screen click on that to enable the Developer mode

6. After that, click on load unpacked on the left upper side of the screen and select the BookMark repo that you have cloned on your computer.

7. For better usage, click on the puzzle icon on the upper right of the browser, then click on the pin icon on MY Bookmarks.

Using the extention

• Open the website that you want to bookmark.
• Click on the BookMark extension icon.
• A user interface similar to this will appear:

• Now, click on the Save Bookmark button. Then, you will see an input field where you can enter the title you want to give to the bookmark.
• You can either give a custom name or leave it empty. If you leave it empty, it will save using the default name.

• You will see the bookmark on the extensions space.
• You can click on the title to visit the website.

Deleting the bookmark

• To remove a bookmark from the list, simply click on the Remove button next to the title, and it will be removed from the list.

Pull request :

1. Make the nessasary changes in the project. Add, Commit and push the project using following commands:

Add all files

git add .

Commit the changes

git commit -m "Write Your commit Message"

Create a new branch

git branch -M <your-name>

Set upstream command to create a PR

git remote add upstream https://github.com/JasonDsouza212/BookMark.git

Push the branch

git push

NOTE

• Make Sure you commit your changes in a new branch.
• Make Sure you Give proper name to your files describing the addition.
• Also Make Sure you comment your code wherever necessary.

✨ Contributors

Show some ❤️ by starring this awesome repository!