From 2820ec49215884a3076522d4dab9ebded8b3c9a7 Mon Sep 17 00:00:00 2001 From: Bhawna Anand <142158409+itsbhh@users.noreply.github.com> Date: Thu, 3 Oct 2024 11:01:56 +0530 Subject: [PATCH] Update README.md Here's the updated pull request description, including a note to change the email address in the contact section: --- ### Pull Request Description This pull request introduces significant updates to the README file, focusing on enhancing user experience and content organization. The key changes include: - **Profiles Section Addition**: A new section titled **Profiles** has been added to the README to effectively showcase individual GitHub contributions. This helps to highlight the work of various contributors and adds value to the repository. - **Resolved Table Formatting Issue**: Fixed a table error caused by the incorrect placement of the `` tag in the profiles table. This correction ensures proper rendering of the table, improving readability and overall appearance. - **Enhanced Navigation Links**: Improved the Table of Contents to include correctly linked navigation to the Profiles section. This makes it easier for users to access specific parts of the document quickly. - **Visual Design Improvements**: - Enhanced the visual aesthetics of the README by implementing hover effects on navigation links, giving users a more interactive experience. - Applied color styling to headings and links to create a more visually appealing layout, making it easier to follow the document. - **Clear Contribution Guidelines**: Included clear and concise contribution guidelines to encourage more users to participate in the project. This section outlines the steps needed to fork the repository, clone it, create branches, and submit pull requests. - **How to Fork Section**: A new **How to Fork** section has been added, providing step-by-step instructions for users on how to create their personal copy of the repository. This helps streamline the contribution process and encourages more users to engage with the project. - **Code of Conduct**: A **Code of Conduct** section has been added to foster a positive and inclusive community. This section outlines the expectations for behavior within the project, promoting respect and collaboration among all contributors. - **Added Contact Information**: Included a contact section for users to reach out with questions or suggestions, promoting open communication within the community. **Please remember to change the email address in this section to reflect your own!** These enhancements aim to improve the usability and engagement of the repository, making it more accessible and user-friendly for current and future contributors. --- Feel free to modify any part of the description as needed! --- README.md | 208 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 154 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 0b091bfb..b4d3b2c2 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,37 @@
-[![All Contributors](https://img.shields.io/badge/all_contributors-44-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-76-orange.svg?style=flat-square)](#contributors-) πŸ”Welcome to the awesome github profiles repo project! 🌟. + +

This README will guide you through the contribution process and provide essential information about the project.

## Running in your local directory ✨ + - npm install ( this will install all the required npm modules) +

Table of Contents

+ + + +

Profiles ✨

-## Profiles ✨ +

Each profile in this repository is designed to showcase individual GitHub contributions effectively.

- +
@@ -76,24 +92,22 @@ - - - - - + + - + + - - + + @@ -101,6 +115,8 @@ + + @@ -108,66 +124,150 @@ + + - - - - + +
Dinesh Talwadker
Dinesh Talwadker
πŸ‘€
m
m
πŸ‘€		 Benjamin
m
πŸ‘€		Bhavya
Bhavya
πŸ‘€		Roshni Kumari
Roshni Kumari
πŸ‘€		Bhavya
Bhavya
πŸ‘€		Roshni Kumari
Roshni Kumari
πŸ‘€		 PAYAL KUMARI
PAYAL KUMARI
πŸ‘€		 sanaya mahajan
sanaya mahajan
πŸ‘€		Samar Sajad
Samar Sajad
πŸ‘€
Ananya Gupta
Ananya Gupta
πŸ‘€		Maheshwari Love
Maheshwari Love
πŸ‘€		 Vysavya
Vysavya
πŸ‘€		Abhishek Bhande
Abhishek Bhande
πŸ‘€		 Himanshu Narware
Himanshu Narware
πŸ‘€		 Zeenat
Zeenat
πŸ‘€		 Rohit Roy
Rohit Roy
πŸ‘€
v_a_r_s_a_n_i
v_a_r_s_a_n_i
πŸ‘€		 ADARSH MAURYA
ADARSH MAURYA
πŸ‘€		 Sanchit Bajaj
Sanchit Bajaj
πŸ‘€		Abhishek Sharma
Abhishek Sharma
πŸ‘€		 Sourabh Kumar
Sourabh Kumar
πŸ‘€		 Soumya Kushwaha
Soumya Kushwaha
πŸ‘€
Jagpreet Singh Khurana
Jagpreet Singh Khurana
πŸ‘€		 hirapurekannu72
hirapurekannu72
πŸ‘€		 Krish Depani
Krish Depani
πŸ‘€		J VENKATA LAKSHMI SAI ROHITH
J VENKATA LAKSHMI SAI ROHITH
πŸ‘€		 Gaurav Kesh Roushan
Gaurav Kesh Roushan
πŸ‘€		 Shaurya Jha
Shaurya Jha
πŸ‘€
Luson Basumatary
Luson Basumatary
πŸ‘€		 iitzIrFan
iitzIrFan
πŸ‘€		 VIJAY KUMAR CHANDRA
VIJAY KUMAR CHANDRA
πŸ‘€
VIJAY KUMAR CHANDRA
VIJAY KUMAR CHANDRA
πŸ‘€		 Ashika Gupta
Ashika Gupta
πŸ‘€		VIJAY KUMAR CHANDRA
VIJAY KUMAR CHANDRA
πŸ‘€
+ + - + + +## Code of Conduct - - +To foster a positive and inclusive community, please adhere to the following guidelines: - - +- **Be Respectful:** Treat everyone with respect. Engage in constructive conversations. +- **No Harassment:** Harassment, bullying, or discrimination will not be tolerated. +- **Report Issues:** If you witness or experience any unacceptable behavior, please report it to the project maintainers. - +Please read the [code of Conduct](CODE_OF_CONDUCT.md) for more clear understanding. +## How to Fork - +Forking allows you to create a personal copy of the repository, where you can experiment and make changes without affecting the original project. Here’s how to do it: -- ["How To Create A GitHub Profile README"](https://www.aboutmonica.com/blog/how-to-create-a-github-profile-readme) - *Monica Powell* -- ["How to Stand Out on Github with Profile READMEs"](https://medium.com/better-programming/how-to-stand-out-on-github-with-profile-readmes-dfd2102a3490?source=friends_link&sk=61df9c4b63b329ad95528b8d7c00061f) - *Jessica Lim* -- ["What's on your GitHub Profile"](https://dev.to/waylonwalker/what-s-on-your-github-profile-40p3) - *Waylon Walker* -- ["3 Ways to Spice up your Github Profile README πŸ”₯"](https://dev.to/jayehernandez/3-ways-to-spice-up-your-github-profile-readme-1276) - *Jaye Hernandez* -- ["Dynamically Generated Github Stats For Your Profile ReadMe"](https://dev.to/anuraghazra/dynamically-generated-github-stats-for-your-profile-readme-o4g) - *Anurag Hazra* -- ["How to create an awesome GIF for your GitHub Profile README"](https://dev.to/satvikchachra/how-to-add-an-awesome-readme-to-your-github-profile-361n) - *Satvik Chachra* -- ["Create a special repository in your GitHub Profile πŸ”¨, supported and unsupported features"](https://torrocus.com/blog/special-github-repository/) - *Alex Malaszkiewicz* -- ["How to create a Github Profile README with Dynamic Github Stats"](https://codewithghazi.com/how-to-create-a-github-profile-readme-with-dynamic-github-stats/) - *Ghazi Khan* -- ["How I Built A Self-Updating README On My Github Profile"](https://www.mokkapps.de/blog/how-i-built-a-self-updating-readme-on-my-git-hub-profile/) - *Michael Hoffmann (Mokkapps)* -- ["Building a self-updating profile README for GitHub"](https://simonwillison.net/2020/Jul/10/self-updating-profile-readme/) - *Simon Willison* -- ["How to create an interactive README for your GitHub profile"](https://kavishhukmani.me/github-profile-interactive-readme-tutorial/) - *Kavish Hukmani* -- ["δ»€δΉˆοΌŸGithub 居焢可δ»₯θΏ™δΉˆηŽ©οΌŸ"](https://zhuanlan.zhihu.com/p/161705999) - *Tw93* -- ["Getting started with Markdown Badges"](https://dev.to/ileriayo/mardown-badges-2og0) - *Ileriayo Adebiyi* -- ["Show your latest dev.to posts automatically on your GitHub profile readme"](https://dev.to/gautamkrishnar/show-your-latest-dev-to-posts-automatically-in-your-github-profile-readme-3nk8) - *Gautam krishna R* -- ["How I Built A Self-Updating README by Webhooks and Netlify Functions"](https://github.com/RaoHai/RaoHai/blob/master/How-I-Built-A-Self-Updating-README-by-Webhooks-and-Netlify-Functions.md/) - *Rao Hai* -- ["Build a Stunning README For Your GitHub Profile"](https://towardsdatascience.com/build-a-stunning-readme-for-your-github-profile-9b80434fe5d7) - *Martin Heinz* -- ["How I added my Spotify statistics to my GitHub readme πŸ“œ"](https://dev.to/gargakshit/how-i-added-my-spotify-statistics-to-my-github-readme-4jdd) - *Akshit Garg* -- ["Static Readme Regeneration"](https://dev.to/aralroca/static-readme-regeneration-4pf2) - *Aral Roca* -- ["How to Create a Self-Updating README.md for Your GitHub Profile"](https://medium.com/@th.guibert/how-to-create-a-self-updating-readme-md-for-your-github-profile-f8b05744ca91) - *Thomas Guibert* -- ["δΈ€ζ–‡ηŽ©θ½¬githubδΈ»ι‘΅"](https://blog.holic-x.com/wv-blog/post/7ad96a5d.html) - *holic-x* - -## Tutorials -- ["Create Impressive GitHub Portfolio"](https://www.youtube.com/watch?v=dkE4mVhwMB4) - *MTECHVIRAL* -- ["How To Create a Github Profile ReadMe"](https://www.youtube.com/watch?v=DOiGs2NiDbU) - *James Q Quick* -- ["How to create a GitHub profile README"](https://www.youtube.com/watch?v=vND_UY7xk24) - *Code With Confidence* -- ["How To Create A GitHub Profile README"](https://www.youtube.com/watch?v=Y1z7_GfEPiE) - *Program With Erik* -- ["Next Level GitHub Profile README"](https://youtu.be/ECuqb5Tv9qI) - *codeSTACKr* - -## Contribute +### Navigate to the Repository: + +- Go to the Awesome GitHub Profiles repository. + +### Click on Fork: + +- On the top right corner, click the "Fork" button. + +### Select Your Account: + +- Choose your GitHub account to create the fork. + +### Clone Your Fork: + +- Use the command below to clone your fork to your local machine: + ```bash + git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git + ``` + +

Tutorials

+ +- ["Create Impressive GitHub Portfolio"](https://www.youtube.com/watch?v=dkE4mVhwMB4) - _MTECHVIRAL_ +- ["How To Create a Github Profile ReadMe"](https://www.youtube.com/watch?v=DOiGs2NiDbU) - _James Q Quick_ +- ["How to create a GitHub profile README"](https://www.youtube.com/watch?v=vND_UY7xk24) - _Code With Confidence_ +- ["How To Create A GitHub Profile README"](https://www.youtube.com/watch?v=Y1z7_GfEPiE) - _Program With Erik_ +- ["Next Level GitHub Profile README"](https://youtu.be/ECuqb5Tv9qI) - _codeSTACKr_ +- ["How To Create A GitHub Profile README"](https://www.aboutmonica.com/blog/how-to-create-a-github-profile-readme) - _Monica Powell_ +- ["How to Stand Out on Github with Profile READMEs"](https://medium.com/better-programming/how-to-stand-out-on-github-with-profile-readmes-dfd2102a3490?source=friends_link&sk=61df9c4b63b329ad95528b8d7c00061f) - _Jessica Lim_ +- ["What's on your GitHub Profile"](https://dev.to/waylonwalker/what-s-on-your-github-profile-40p3) - _Waylon Walker_ +- ["3 Ways to Spice up your Github Profile README πŸ”₯"](https://dev.to/jayehernandez/3-ways-to-spice-up-your-github-profile-readme-1276) - _Jaye Hernandez_ +- ["Dynamically Generated Github Stats For Your Profile ReadMe"](https://dev.to/anuraghazra/dynamically-generated-github-stats-for-your-profile-readme-o4g) - _Anurag Hazra_ +- ["How to create an awesome GIF for your GitHub Profile README"](https://dev.to/satvikchachra/how-to-add-an-awesome-readme-to-your-github-profile-361n) - _Satvik Chachra_ +- ["Create a special repository in your GitHub Profile πŸ”¨, supported and unsupported features"](https://torrocus.com/blog/special-github-repository/) - _Alex Malaszkiewicz_ +- ["How to create a Github Profile README with Dynamic Github Stats"](https://codewithghazi.com/how-to-create-a-github-profile-readme-with-dynamic-github-stats/) - _Ghazi Khan_ +- ["How I Built A Self-Updating README On My Github Profile"](https://www.mokkapps.de/blog/how-i-built-a-self-updating-readme-on-my-git-hub-profile/) - _Michael Hoffmann (Mokkapps)_ +- ["Building a self-updating profile README for GitHub"](https://simonwillison.net/2020/Jul/10/self-updating-profile-readme/) - _Simon Willison_ +- ["How to create an interactive README for your GitHub profile"](https://kavishhukmani.me/github-profile-interactive-readme-tutorial/) - _Kavish Hukmani_ +- ["δ»€δΉˆοΌŸGithub 居焢可δ»₯θΏ™δΉˆηŽ©οΌŸ"](https://zhuanlan.zhihu.com/p/161705999) - _Tw93_ +- ["Getting started with Markdown Badges"](https://dev.to/ileriayo/mardown-badges-2og0) - _Ileriayo Adebiyi_ +- ["Show your latest dev.to posts automatically on your GitHub profile readme"](https://dev.to/gautamkrishnar/show-your-latest-dev-to-posts-automatically-in-your-github-profile-readme-3nk8) - _Gautam krishna R_ +- ["How I Built A Self-Updating README by Webhooks and Netlify Functions"](https://github.com/RaoHai/RaoHai/blob/master/How-I-Built-A-Self-Updating-README-by-Webhooks-and-Netlify-Functions.md/) - _Rao Hai_ +- ["Build a Stunning README For Your GitHub Profile"](https://towardsdatascience.com/build-a-stunning-readme-for-your-github-profile-9b80434fe5d7) - _Martin Heinz_ +- ["How I added my Spotify statistics to my GitHub readme πŸ“œ"](https://dev.to/gargakshit/how-i-added-my-spotify-statistics-to-my-github-readme-4jdd) - _Akshit Garg_ +- ["Static Readme Regeneration"](https://dev.to/aralroca/static-readme-regeneration-4pf2) - _Aral Roca_ +- ["How to Create a Self-Updating README.md for Your GitHub Profile"](https://medium.com/@th.guibert/how-to-create-a-self-updating-readme-md-for-your-github-profile-f8b05744ca91) - _Thomas Guibert_ +- ["δΈ€ζ–‡ηŽ©θ½¬ github δΈ»ι‘΅"](https://blog.holic-x.com/wv-blog/post/7ad96a5d.html) - _holic-x_ + + +

Contribute

Contributions are always welcome! -Please read the [contribution guidelines](contributing.md) first. +To ensure a smooth collaboration process, Follow these steps: + + + + +1. **Fork the Repository:** + + - Click the "Fork" button on the top right of the repository page. This creates a copy of the repository under your GitHub account. + +2. **Clone Your Fork:** + + - Run the following command in your terminal: + ```bash + git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git + ``` + - This command downloads your fork to your local machine. + +3. **Create a Branch:** + + - Navigate into the cloned repository: + ```bash + cd Awesome-Github-Profiles + ``` + - Create a new branch for your feature or fix: + ```bash + git checkout -b your-feature-branch + ``` + +4. **Make Your Changes:** + + - Implement your changes in your local repository. Make sure your code is clean and follows the project's coding style guidelines. + +5. **Test Your Changes:** + + - If applicable, run tests to ensure that your changes do not break existing functionality. + +6. **Commit Your Changes:** + + - Commit your changes with a clear and descriptive message: + ```bash + git commit -m "Add a feature or fix a bug" + ``` + +7. **Push to Your Fork:** + + - Push your changes back to your forked repository: + ```bash + git push origin your-feature-branch + ``` + +8. **Create a Pull Request:** + - Navigate to the original repository where you want to propose your changes. + - Click on "New Pull Request" and follow the instructions to submit your changes for review. + +

Special Thanks πŸ™‡

+ +- [Dinesh Talwadker](https://github.com/dinxsh) [Hemant](https://github.com/dinxsh), [Nishant](https://github.com/dinxsh), [Ayushman](https://github.com/dinxsh) for being a core for this repo! + +## Contact Information + +If you have questions, suggestions, or feedback, please reach out via email at email@example.com. You can also join our discussion forum [here](https://github.com/recodehive/awesome-github-profiles/discussions). -## Special Thanks πŸ™‡ -- [Dinesh Talwadker](https://github.com/dinxsh) [Hemant](https://github.com/dinxsh), [Nishant](https://github.com/dinxsh), [Ayushman](https://github.com/dinxsh)for being a core for this repo! +We value open communication and are happy to help!