git-tips/contributing.md

23 lines
578 B
Markdown
Raw Permalink Normal View History

2015-07-15 11:10:05 +00:00
## Easy steps:
2015-07-15 13:39:15 +00:00
* [Fork](https://github.com/git-tips/tips/network) the repo.
2015-07-17 07:31:25 +00:00
* Install the deps:
2015-07-15 11:26:39 +00:00
```sh
$ cd tips && npm install
```
2015-07-17 07:31:25 +00:00
2016-06-08 21:00:07 +00:00
:warning: don't fail to think that this is optional, because if you don't install the dependencies you won't get the benefit of auto-updating README and TOC and your PR will likely to not get merged because of that.
2015-07-15 11:26:39 +00:00
* Edit [tips.json](./tips.json) to add your tip in the below format:
2015-07-15 11:10:05 +00:00
2015-07-15 11:26:39 +00:00
```js
2015-07-15 11:10:05 +00:00
{
"title": <your_tip_title>,
2015-07-17 07:31:25 +00:00
"tip": <your_tip>,
"alternatives": [Optional list of alternatives]
2015-07-15 11:10:05 +00:00
}
```
* Commit, push and send a PR!