search

flyingpie / windows-terminal-quake

Turn any app into a Quake-style toggleable app.
https://wtq.flyingpie.nl
MIT License
547 stars 35 forks source link

Add initial contributing doc 📖 #89

Closed webbertakken closed 3 years ago

webbertakken commented 3 years ago

Adds initial version of the CONTRIBUTING.md, which makes it easier for contributors to get started.

flyingpie commented 3 years ago

@webbertakken Looks awesome! One question: do you think it would be useful to use the https-endpoint as a default, or perhaps list both? Not sure if the ssh one much cause problems with certain auth setups or firewall.s

webbertakken commented 3 years ago

Setting up and using an ssh key for git is actually a very streamlined process. There is no auth setup beyond creating the key once and adding it to ssh-agent. I usually refer to the GitHub docs for it when needed.

I think generally most people that are used to git have set up their ssh key whereas people newer to git often use a GUI to clone and manage their projects.

That said, I have no personal preference for documenting one way of cloning or the other or both. A quick google also didn't yield a clear winner. Just let me know your preference and I'll update the PR accordingly. :)