Note
This repository is not included in the Hacktoberfest event.
It is used to practice when making your first steps into open-source.
This is collection of really dope Github README Profiles, that you can take inspiration from. Wanna add your your awesome readme to our list? Sure, follow along✨
Welcome to Design & Code where anyone interested in designing and coding can connect and interact with fellow peers from all over the globe and not only learn but also collaborate on various projects!
root
├── readmes
│ ├── Your Name (folder)
│ │ ├── README.MD
│ │ └── Assets (folder)
│ │
│ │
│ └── Your Name (folder)
│ ├── README.MD
│ └── Assets (folder)
│
│
└── README.MD
Want to add your project to the repo? We invite you to contribute. 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>/Dope-Github-Readmes.git
3. Navigate to the project directory 📁 .
cd Dope-Github-Readmes
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/Design-and-Code/Dope-Github-Readmes.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. Then navigate to the readmes directory.
cd readmes
8. Add your README and assests under a folder with your name (replace your-name with name).
mkdir your-name
cd your-name
10. Track your changes ✔.
git add .
11. Commit your changes .
git commit -m "Relevant message"
12. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
13. To create a pull request, click on compare and pull requests.
14. Add appropriate title and description to your pull request explaining your changes and efforts done.
15. Click on Create Pull Request.
16 Voila! You have made a PR to the Projects-showcase 💥 . Wait for your submission to be accepted and your PR to be merged.
Note:
Under the
assestsfolder, you can add the resources used to build your readme, so others can reference it
Devraj Chatribin |
Medam Greeshma |