| # [<tag>] (If applied, this commit will...) <subject> (Max 72 char) | |
| # |<---- Preferably using up to 50 chars --->|<------------------->| | |
| # Example: | |
| # [feat] Implement automated commit messages | |
| # (Optional) Explain why this change is being made | |
| # |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->| | |
| # (Optional) Provide links or keys to any relevant tickets, articles or other resources | |
| # Example: Github issue #23 |
| gem 'stackprof', require: false | |
| gem 'ruby-prof', require: false |
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.
