Suggest using "Treeless clone" to contributors (#4433)

* Suggest using "Treeless clone" to contributors

Following a recent GitHub blog post [1], this adds a suggestion to the
Contributing Guidelines to use a "Treeless clone" when cloning this
repository. Since the commit history is generally not super important to
contributors, this can significantly speed up cloning without any real
downside.

--
1. https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/

* Add HTTPS version for cloning the repository

* Add comments and highlighting for cloning snippet

* Add clone instruction for using GitHub CLI

* Increase spacing
This commit is contained in:
Eric Cornelissen 2020-12-23 19:21:17 +01:00 committed by GitHub
parent 5b60aa46c0
commit 4e199bb87b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,6 +3,19 @@
Simple Icons welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please do the following: Simple Icons welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please do the following:
1. Fork this repository 1. Fork this repository
1. (Optional) Clone the fork
```bash
# Using SSH
git clone --filter=tree:0 git@github.com:simple-icons/simple-icons.git
# Using HTTPS
git clone --filter=tree:0 https://github.com/simple-icons/simple-icons.git
# Using GitHub CLI
gh repo clone simple-icons/simple-icons -- --filter=tree:0
```
1. Create a new branch from the latest `develop` (read more [here](https://guides.github.com/introduction/flow/)) 1. Create a new branch from the latest `develop` (read more [here](https://guides.github.com/introduction/flow/))
1. Start hacking on the new branch 1. Start hacking on the new branch
1. Commit and push to the new branch 1. Commit and push to the new branch
@ -31,11 +44,11 @@ We welcome icon requests. Before you submit a new issue please make sure the ico
- Allowed: Space agencies - Allowed: Space agencies
- Symbols, including flags and banners - Symbols, including flags and banners
- Sport clubs - Sport clubs
- Allowed: Sport organizations - Allowed: Sport organizations
- Yearly releases - Yearly releases
- Universities or other educational institutions - Universities or other educational institutions
- Any brands representing individuals rather than an organization, company or product. This includes musicians, bands, and social media personalities. - Any brands representing individuals rather than an organization, company or product. This includes musicians, bands, and social media personalities.
If you are in doubt, feel free to submit it and we'll have a look. If you are in doubt, feel free to submit it and we'll have a look.
When submitting a request for a new or updated icon include helpful information such as: When submitting a request for a new or updated icon include helpful information such as: