DEV Community

Cover image for Showcase Your GitHub Profile: Contribute to the "Cool GitHub Profile README" Repository!
Nikhil Shukla
Nikhil Shukla

Posted on

Showcase Your GitHub Profile: Contribute to the "Cool GitHub Profile README" Repository!

Hey Dev Community! πŸ‘‹

I'm excited to share a project I've been working on: the Cool GitHub Profile README repository! This repository is all about collecting and showcasing the coolest GitHub profile READMEs. Whether you’ve already crafted an amazing README or you’re just starting out, we’d love to see your contribution!

Why Contribute?

  1. Inspiration for Others: Your profile README could inspire fellow developers.
  2. Showcase Your Creativity: Display your unique style and personality.
  3. Learn Open Source Contribution: If you haven't made any open source contributions yet, this is the perfect time to get started!

How to Contribute to this repo

Contributing is simple and it's a great way to get familiar with the open source workflow. Here’s a step-by-step guide:

1. Fork the Repository:

  • Go to the Cool GitHub Profile README repo. Fork the repo
    • Click on the "Fork" button at the top right of the page and after that click on Create Fork. This creates a copy of the repository in your GitHub account. Forking Image

2. Check out the Contribution Guidelines:

3. Edit the README.md File:

  • Navigate to the README.md file in your forked repository.
    • Click on the "Edit this file" pencil button on the right side of the opened tab.

Edit Button

4. Add Your README.md to the Relevant Category:

  • Choose the compatible/relevant README category. For example, if your README is visually Minimalistic ✨, add it to the Minimalistic ✨ category.

readme category

  • Add your profile by inserting the following code under the chosen category (replace with your username):
["Your Name"](https://github.com/<your-username>/<your-username>)
Enter fullscreen mode Exit fullscreen mode
  • Example: [Nikhil Shukla](https://github.com/nikhil-shuklaa/nikhil-shuklaa)

5. Commit Your Changes:

  • Click on "Commit changes"
    • Add a commit message like:
Added [Your Name] in [Category] - README.md
Enter fullscreen mode Exit fullscreen mode
  • Click on the "Commit changes" Button.

6. Verify Your Changes:

  • Navigate back to the root of your forked repository.
    • Verify that your name has been added to the list in your selected category.

7. Create a Pull Request:

  • In your forked repository, click on the "Contribute" button.
    • Click on the "Open pull request" button below. Contribute button

8. Compare Changes and Create Pull Request:

  • The "Comparing changes" tab will open.
    • Fill in all the necessary details.

Example
Create Pull Request

  • Click on "Create pull request"

And that's it! You've made an open-source contribution! πŸŽ‰

Ready to Get Started?

Head over to the Cool GitHub Profile README repo and start showcasing your awesome profiles. If you need some inspiration, feel free to check out my GitHub profile README. Whether you’re an open-source newbie or a seasoned contributor, we can’t wait to see what you bring to the table!

If you have any ideas or suggestions, please let me know. I’m always happy to discuss and contribute!

Thank you so much for considering contributing. Let's make this a wonderful collection together!

Happy Coding!

Top comments (5)

Collapse
 
ccoveille profile image
Christophe Colombier • Edited

Your project looks like one that just started

GitHub logo LIGMATV / awesome-readme-profile-preview

A realtime markdown preview of Awesome README Profiles by categories.

Powered by Docsify.js and docsify-theme-github

A realtime markdown preview of Awesome README Profiles by categories.

Screenshot Capture - 2024-05-26 - 15-52-15
Example of Awesome README Profile Preview

Inspired by awesome-github-profile-readme. since the last merged pull request in 2022, I start trying to create the new awesome-readmes project with realtime preview, and the same categories like on awesome-github-profile-readme.

Contents:

Categories

GitHub Actions πŸ€–

Game Mode πŸš€

Code Mode πŸ‘¨πŸ½β€πŸ’»

Dynamic Realtime πŸ’«

A Little Bit of Everything πŸ˜ƒ

Descriptive πŸ—’

Simple but Innovative Ones πŸ€—

Typing.. Mode 🎰

Anime πŸ‘Ύ

Minimalistic ✨

GIFS πŸ‘»

Just Images 🎭

Badges 🎫

…

I posted a comment on a old project that announced the new project creation

Collapse
 
jgphilpott profile image
Jacob Philpott

Is this just a copycat repo? Why not contribute to Nikhil's repo instead so that work isn't duplicated and attention divided?

Collapse
 
ccoveille profile image
Christophe Colombier

The project that started is not mine. I was bringing attention on the fact multiple people where doing the same thing concurrently and yes, I already suggested them to work together

github.com/abhisheknaiidu/awesome-...

Collapse
 
nikhilshukla profile image
Nikhil Shukla

Yes :)

Collapse
 
cheikhnouha profile image
Cheikhnouha

I’m so success to your post