Skip to content

Commit

Permalink
Merge pull request #298 from Harshh18/update-readme
Browse files Browse the repository at this point in the history
docs: Update README and added CONTRIBUTING.md
  • Loading branch information
avinash201199 authored Oct 29, 2024
2 parents 6fd5648 + fcf100a commit c46ff57
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 112 deletions.
66 changes: 66 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
## To start contributing, follow the below guidelines:

**1.** Fork this repository.

**2.** Clone your forked copy of the project.

```
git clone https://github.com/<your_user_name>/Portfolio-Collection.git
```

**3.** Navigate to the project directory :file_folder: .

```
cd Portfolio-Collection
```

**4.** Add a reference (remote) to the original repository.

```
git remote add upstream https://github.com/avinash201199/Portfolio-Collection.git
```

**5.** Check the remotes for this repository.

```
git remote -v
```

**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

```
git pull upstream main
```

**7.** Create a new branch.

```
git checkout -b <your_branch_name>
```

**8.** Perform your desired changes to the code base.

**9.** Track your changes:heavy_check_mark: .

```
git add .
```

**10.** Commit your changes .

```
git commit -m "Relevant message"
```

**11.** Push the committed changes in your feature branch to your remote repo.

```
git push -u origin <your_branch_name>
```
Replace "<your_branch_name>" with a descriptive name for your branch — for example, `update-readme`.

**12.** To create a pull request, click on `compare and pull requests`.

**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.

**14.** Click on `Create Pull Request`.
137 changes: 25 additions & 112 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,28 @@
<h1 align="center">Portfolio-Collection 🚀</h1>
![Portfolio-Collection](https://socialify.git.ci/avinash201199/Portfolio-Collection/image?font=Jost&forks=1&issues=1&name=1&owner=1&stargazers=1&theme=Auto)
<div align="center">
<strong>Welcome to Portfolio-Collection repository 🚀</strong>
</div>
<br>

Welcome to the Portfolio-Collection repository! This project is a curated compilation of diverse and creative portfolio source code, providing a space for developers to showcase their work and inspire others in the community. Whether you're seeking inspiration for your own portfolio or eager to contribute and collaborate, you've come to the right place!
Showcase your talent, get inspired, and collaborate with a creative collection of portfolio source code designed for developers like you!

<h2 align="center">Description</h2>
Whether you’re revamping your portfolio or seeking fresh ideas, this is your go-to hub for creative presentation of skills and projects. Contribute your own work and collaborate with a community that values creativity, learning, and the evolution of portfolio design!

In the ever-evolving landscape of technology and design, having a standout portfolio is crucial for professionals and enthusiasts alike. The Portfolio-Collection repository aims to bring together a wide array of portfolio source code, showcasing the creativity, innovation, and unique approaches of developers from around the world.
## Star History 🌟
<a href="https://star-history.com/#avinash201199/Portfolio-Collection&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=avinash201199/Portfolio-Collection&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=avinash201199/Portfolio-Collection&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=avinash201199/Portfolio-Collection&type=Date" />
</picture>
</a>

<h3 align="center">Features</h3>
## Contributing 🤝
Contribute by adding your portfolio to this repository and let your work inspire developers across the community!

- **Diverse Source Code:** Our collection includes portfolios designed for various purposes, from personal branding to specific project showcases. Explore different coding styles, frameworks, and design philosophies.
For information on how to contribute to this repository, check out the [Contributing Guidelines](CONTRIBUTING.md).

- **Inspiration Hub:** Whether you're a seasoned developer looking to revamp your portfolio or a beginner seeking ideas, Portfolio-Collection serves as a vibrant hub of inspiration. Discover new ways to present your skills and projects.

- **Collaborative Environment:** We believe in the power of collaboration. Contribute to this repository, share your portfolio, and be part of a community that values creativity and learning. Help shape the future of portfolio design!

<h2 align="center">Badges 🛡️</h2>

[![GitHub issues](https://img.shields.io/github/issues/avinash201199/Portfolio-Collection)](https://github.com/avinash201199/Portfolio-Collection/issues)
[![GitHub forks](https://img.shields.io/github/forks/avinash201199/Portfolio-Collection)](https://github.com/avinash201199/Portfolio-Collection/network)
[![GitHub stars](https://img.shields.io/github/stars/avinash201199/Portfolio-Collection)](https://github.com/avinash201199/Portfolio-Collection/stargazers)

# How to Rate: 🌟

1. **Login with GitHub:**
- Log in with your GitHub account on [Repo Rater](https://repo-rater.eddiehub.io/) 🚀.

2. **Add Rating:**
- Navigate to the "Add Rating" section 🌐.

3. **Paste Repository Link:**
- Paste the link to this repository: [Portfolio-Collection](https://github.com/avinash201199/Portfolio-Collection) 🔗.

4. **Provide Rating:**
- Give your rating based on your experience ⭐.

5. **Submit:**
- Submit your rating, 📝


# Contribution is fun! :green_heart:

In order to make a hassle-free environment, I implore you all (_while contributing_) to follow the instructions mentioned below!

Happy Submissions :slightly_smiling_face:

Your feedback is valuable! Thank you for contributing to the growth of the Portfolio-Collection repository. Happy rating! 🌈✨
Happy Submissions 🙂

Got it! Here’s a concise section for that:

Expand All @@ -65,75 +43,10 @@ Got it! Here’s a concise section for that:
Thank you for adding to the Portfolio-Collection! 🎉


<h2 align="center">Contribution Guidelines🏗</h2>

Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and make it better.
To start contributing, follow the below guidelines:

**1.** Fork this repository.

**2.** Clone your forked copy of the project.

```
git clone https://github.com/<your_user_name>/Portfolio-Collection.git
```

**3.** Navigate to the project directory :file_folder: .

```
cd Portfolio-Collection
```

**4.** Add a reference(remote) to the original repository.

```
git remote add upstream https://github.com/avinash201199/Portfolio-Collection.git
```

**5.** Check the remotes for this repository.

```
git remote -v
```

**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

```
git pull upstream main
```

**7.** Create a new branch.

```
git checkout -b <your_branch_name>
```

**8.** Perform your desired changes to the code base.

**9.** Track your changes:heavy_check_mark: .

```
git add .
```

**10.** Commit your changes .

```
git commit -m "Relevant message"
```

**11.** Push the committed changes in your feature branch to your remote repo.

```
git push -u origin <your_branch_name>
```

**12.** To create a pull request, click on `compare and pull requests`.

**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.

**14.** Click on `Create Pull Request`.


**15** Voila :exclamation: You have made a PR to the Portfolio-Collection :boom: . Wait for your submission to be accepted and your PR to be merged.(Hacktoberfest 2023)
## Our Contributors ✨
<a href="https://github.com/avinash201199/Portfolio-Collection/graphs/contributors">
<img src="https://contrib.rocks/image?repo=avinash201199/Portfolio-Collection" />
</a>

## License ⚖
This project is licensed under the [MIT License](LICENSE).

0 comments on commit c46ff57

Please sign in to comment.