| Taken from: http://www.alexkras.com/19-git-tips-for-everyday-use/ | |
| 19 Tips For Everyday Git Use | |
| September 8, 2015 by Alex Kras 31 Comments | |
| TwitterHacker NewsRedditFacebookShare1,491 | |
| I’ve been using git full time for the past 4 years, and I wanted to share the most practical tips that I’ve learned along the way. Hopefully, it will be useful to somebody out there. | |
| If you are completely new to git, I suggest reading Git Cheat Sheet first or checking out this free tutorial. This article is aimed at somebody who has been using git for three months or more. |
| Let's lool at the following example structure for RESTful API using Node.js, Express.js included tesing | |
| app/ | |
| |---models/ | |
| |---controller/ | |
| |---helpers/ | |
| |---middlewares/ | |
| |---tests/ | |
| |---models/ | |
| |---controllers/ |
At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.