5 General Tips¶
5.1 Naming Rules¶
For name of repos, one should use all lowercase letters with dash (-) connecting words.
Example: coding-learning, py-starter
For git commit comments, one should use “noun” + “verb past tense”, all in lower-case unless specific words needed.
Example: README updated, more functions added
5.2 Choose License¶
You can select a type of license for your project here: choose a license.
In this repo, you can see MIT License.
5.3 Design Logo¶
A logo is not really necessary for your project, but you can always use few minutes to design one simple logo that based on exist template.
You can use different webside to do so. In this repo, you can see logo designed from here: wix logo desin. Obviously, high resolution logo is expensive, however the low res one, which is good enough for us, is always free to get.
5.4 Markdown¶
Markdown, or .md file, is usful in github. If you wanna use some tricks in markdown file, all you need is google.com.
Also, github supports some unique markdown feature, such as:
- [ ] To-do List
- [x] To-do List (Done)
5.6 Fancy Badge¶
Do you want to have some fancy badges in your README, like this:
Check shields.io to get your own badge!