https://github.com/tusuii/workshop_projects
workshop projects goes here
https://github.com/tusuii/workshop_projects
Last synced: 22 days ago
JSON representation
workshop projects goes here
- Host: GitHub
- URL: https://github.com/tusuii/workshop_projects
- Owner: tusuii
- License: mit
- Created: 2023-07-27T14:33:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T17:57:22.000Z (7 months ago)
- Last Synced: 2024-10-27T21:06:24.252Z (7 months ago)
- Language: JavaScript
- Size: 61.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## **Description**
This repository contains a collection of projects that I have developed, showcasing expertise in various domains and technologies. Each project has its own dedicated subdirectory, accompanied by a detailed README.md file providing essential information and instructions for contributing and using the projects effectively.
**Table of Contents**
---------------------
1. [Project Directory Structure](#project-directory-structure)
2. [How to Contribute](#how-to-contribute)
- [Forking the Repository](#forking-the-repository)
- [Setting Up the Local Development Environment](#setting-up-the-local-development-environment)
- [Creating a New Branch](#creating-a-new-branch)
- [Making Changes and Committing](#making-changes-and-committing)
- [Pushing Changes and Creating a Pull Request](#pushing-changes-and-creating-a-pull-request)
- [Reviewing and Merging the Pull Request](#reviewing-and-merging-the-pull-request)
- [Syncing with Upstream](#syncing-with-upstream)
3. [License](#license)
4. [Contact](#contact)
**Project Directory Structure (Example)**
-------------------------------
```
project-name/
│
├── project1/
│ ├── file1.js
│ ├── file2.html
│ ├── assets/
│ │ └── images/
│ └── README.md
│
├── project2/
│ ├── file3.py
│ ├── file4.css
│ └── README.md
│
├── shared-assets/
│ ├── logo.png
│ └── resources/
│
└── README.md
```
**How to Contribute**
---------------------
Contributions to this project are welcomed and encouraged. Whether you want to fix a bug, add new features, or improve documentation, your contributions are highly valuable.
### Forking the Repository
1. Navigate to the project's GitHub page: [https://github.com/tusuii/workshop_projects/tree/main](https://github.com/tusuii/workshop_projects/tree/main).
2. Click on the "Fork" button located at the top right corner of the page. This will create a copy of the repository in your GitHub account.
### Setting Up the Local Development Environment
1. Clone the forked repository to your local machine:
```
git clone https://github.com/your-username/project-name.git
```
2. Change into the project directory:
```
cd project-name
```
### Creating a New Branch
1. Create a new branch for your contribution:
```
git checkout -b feature/your-feature
```
### Making Changes and Committing
1. Make the necessary changes to the project files.
2. Stage the changes:
```
git add .
```
3. Commit the changes with a meaningful commit message:
```
git commit -m "Add your feature"
```
### Pushing Changes and Creating a Pull Request
1. Push your changes to your forked repository:
```
git push origin feature/your-feature
```
2. Navigate to your forked repository on GitHub and click on the "Compare & pull request" button.
### Reviewing and Merging the Pull Request
1. The project maintainers will review your pull request and provide feedback if needed.
2. Once the pull request is approved, it will be merged into the main repository.
### Syncing with Upstream
To keep your forked repository up-to-date with the main repository (the original project):
```
git remote add upstream https://github.com/original-project-username/project-name.git
git fetch upstream
git checkout main
git merge upstream/main
```
**License**
-----------
This project is licensed under the [MIT License](LICENSE). Please refer to the LICENSE file for more details.
**Contact**
-----------
If you have any questions, suggestions, or need assistance, feel free to reach out to me at [Discussion Section](https://github.com/tusuii/workshop_projects/discussions). You can also find me on [LinkedIn](https://www.linkedin.com/in/subodh-kamble-16a237168/).
Thank you for your interest in this project! Happy contributing! 😊