diff --git a/README.md b/README.md index 29f5ed57c..d052d05e9 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,35 @@ ### Description This is an open-source repository that collects different JavaScript projects. For all who love JavaScript, here you can explore a diverse array of projects. This collection highlights the creativity and expertise of developers, offering inspiration and practical examples for JavaScript enthusiasts of all levels. -### Usage -This repository contains a collection of mini JavaScript projects, each designed to demonstrate a specific concept or feature. Here's how you can use these projects: +*** -πŸ‘‰ **Choose a project** +### How to Contribute +Make some awesome projects, put them in your directory and create a pull request. and DONE βœ… -Browse the repository to find a project that interests you. Each project is contained within its own folder. +### Steps to Raise and get your PR Merged successfully. +πŸ‘‰ Fork this repository -πŸ‘‰ **Clone the repository** +πŸ‘‰ Clone the repository into your local system -Clone this repository to your local machine. +πŸ‘‰ Create a branch ```projectname-username```, e.g. - ```git checkout -b ChatApp-thinkswell``` -πŸ‘‰ **Navigate to the project folder** +πŸ‘‰ Add your projects in the respective directory (if exist otherwise create one), the name of directory should be your ```ProjectName/USERNAME```, e.g. - ChatApp/thinkswell -Change directory to the specific project you want to explore. +πŸ‘‰ **Add ```One project``` at a time** -πŸ‘‰ **Open index.html or index.js in your browser** +πŸ‘‰ **Add & commit**, use ```git add -A```, than ```git commit -m "Your commit message about project"``` -Most projects include an index.html or index.js file. Open this file in your web browser to interact with the project. +πŸ‘‰ **Push changes to GitHub**, e.g. - ```git push origin ChatApp-thinkswell``` -πŸ‘‰ **Explore and interact** +πŸ‘‰ **Click** on `Create a Pull Request`. -Have fun with the project! +πŸ‘‰ Attach some **SCREENSHOTS/GIF** or **link of your working project** in the description _**❗Important❗**_. -*** +πŸ‘‰ **Submit** the PR. +πŸ‘‰ **Leave a ⭐ to the repo and `FOLLOW` me if you liked the project.** + +*** ### What You Can Contribute We welcome contributions from the community to enhance and expand our collection of mini JavaScript projects. Here are several ways you can contribute: @@ -39,44 +43,36 @@ Do you have a creative JavaScript project that you think would be a great additi If you find any issues or bugs in existing projects, please report them by creating an issue. Better yet, submit a pull request with a fix! -πŸ‘‰ **Enhancements** - -Have an idea to improve an existing project? Whether it's enhancing functionality, improving performance, or refining the user interface, we're open to your suggestions. +πŸ‘‰ **Create Issues** -πŸ‘‰ **Documentation** +Have an idea for a new project? Create a new issue by clicking on the `New Issue` button and updating the pre-defined template. -Help us improve our documentation. If you find areas in the README or project documentation that could be clearer, submit a pull request with your changes. - - -### How to Contribute -Make some awesome projects, put them in your directory and create a pull request. and DONE βœ… +We're happy to merge awesome portfolio to this repository! *** -### Steps to Raise and get your PR Merged successfully. -πŸ‘‰ Fork this repository - -πŸ‘‰ Clone the repository into your local system +### Usage +This repository contains a collection of mini JavaScript projects, each designed to demonstrate a specific concept or feature. Here's how you can use these projects: -πŸ‘‰ Create a branch ```projectname-username```, e.g. - ```git checkout -b ChatApp-thinkswell``` +πŸ‘‰ **Choose a project** -πŸ‘‰ Add your projects in the respective directory (if exist otherwise create one), the name of directory should be your ```ProjectName/USERNAME```, e.g. - ChatApp/thinkswell +Browse the repository to find a project that interests you. Each project is contained within its own folder. -πŸ‘‰ Add ```One project``` at a time +πŸ‘‰ **Clone the repository** -πŸ‘‰ Add & commit, use ```git add -A```, than ```git commit -m "Your commit message about project"``` +Clone this repository to your local machine. -πŸ‘‰ Push changes to GitHub, e.g. - ```git push origin ChatApp-thinkswell``` +πŸ‘‰ **Navigate to the project folder** -πŸ‘‰ Click on `Create a Pull Request`. +Change directory to the specific project you want to explore. -πŸ‘‰ Attach some SCREENSHOTS GIF or link of your working project in the description _❗Important❗_. +πŸ‘‰ **Open index.html or index.js in your browser** -πŸ‘‰ Submit the PR. +Most projects include an index.html or index.js file. Open this file in your web browser to interact with the project. -πŸ‘‰ Leave a ⭐ to the repo and `FOLLOW` me if you liked the project. +πŸ‘‰ **Explore and interact** -We're happy to merge awesome portfolio to this repository! +Have fun with the project! ***