Skip to content

Commit 029540d

Browse files
docs(CONTRIBUTING.md): update guide
1 parent 4fc6ff0 commit 029540d

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
- Commit summaries must be in the following format `<type>(<scope>): <description>`.
2-
- type - `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`
3-
- scope - file affected, or general scope of commit
1+
- Commit summaries must be in the following format `<type>(<scope>): <description>`
2+
- type - `ci`, `fix`, `feat`, `docs`, `test`, `perf`, `style`, `build`, `chore`, `revert`, `refactor`
3+
- scope - file affected e.g (`fix(lib/index): <description>`), or general scope of commit
44
- description - Your commit summary
5-
6-
- Write tests that cover your changes
7-
8-
- Make sure `npm run lint` and `npm test` both pass before submitting PR.
9-
105
- Add docs if appropriate
6+
- Write tests that cover your changes
7+
- Make sure `npm run lint` and `npm test` both pass before submitting a PR
8+
- Add yourself as a contributor in `README.md` && `package.json`
119

12-
- Add yourself as Contributor in README.md. If you do not know the `id` for your account, it can be found at `https://api.github.com/users/<username>`
10+
**README.md**
11+
```html
12+
<td align="center">
13+
<img
14+
width="150"
15+
height="150"
16+
src="https://github.com/{{ user }}.png?v=3&s=150">
17+
<br />
18+
<a href="https://github.com/{{ user }}">{{ Name }}</a>
19+
</td>
20+
```
1321

14-
```html
15-
<td align="center">
16-
<img
17-
width="150"
18-
height="150"
19-
src="https://avatars.githubusercontent.com/u/{{ id }}?v=3&s=150">
20-
<br />
21-
<a href="https://github.com/{{ login }}">{{ Name }}</a>
22-
</td>
23-
```
22+
**package.json**
23+
```
24+
{
25+
"contributors": [
26+
"{{ firstname }} {{ lastname }} <email>"
27+
]
28+
}
29+
```

0 commit comments

Comments
 (0)