Mirror/git-stats
1
0
Fork 0
mirror of https://github.com/IonicaBizau/git-stats.git synced 2024-12-22 13:22:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Minor fixes

Browse source
This commit is contained in:
Ionică Bizău 2015-11-01 12:39:28 +02:00
parent 85080f12bd
commit bc36b3e0c8
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md
View file

@ -7,16 +7,17 @@ requested. :sparkles:
## Discuss the changes before doing them ## Discuss the changes before doing them
- First of all, open an issue in the repository, using the [bug tracker][1], - First of all, open an issue in the repository, using the [bug tracker][1],
describing the contribution you'd like to make, the bug you found or any describing the contribution you would like to make, the bug you found or any
other ideas you have. This will help us to get you started on the right other ideas you have. This will help us to get you started on the right
foot. foot.
- If it makes sense, add the platform and software information (e.g. operating - If it makes sense, add the platform and software information (e.g. operating
system, Node.JS version etc), screenshots (so we can see what you're seeing). system, Node.JS version etc.), screenshots (so we can see what you are
seeing).
- It's recommended to wait for feedback before continuing to next steps. However, - It is recommended to wait for feedback before continuing to next steps.
if the issue is clear (e.g. a typo) and the fix is simple, you can continue However, if the issue is clear (e.g. a typo) and the fix is simple, you can
and fix it. continue and fix it.
## Fixing issues ## Fixing issues
- Fork the project in your account and create a branch with your fix: - Fork the project in your account and create a branch with your fix:
@ -26,13 +27,14 @@ requested. :sparkles:
[code style][2]. If the project contains tests (generally, the `test` [code style][2]. If the project contains tests (generally, the `test`
directory), you are encouraged to add a test as well. :memo: directory), you are encouraged to add a test as well. :memo:
- If the project contains a `package.json` file add yourself in the - If the project contains a `package.json` or a `bower.json` file add yourself
`contributors` array (if it doesn't exist, create it): in the `contributors` array (or `authors` in the case of `bower.json`;
if the array does not exist, create it):
```json ```json
{ {
"contributors": [ "contributors": [
"Your Name <and@email.address> (http://your.website) "Your Name <and@email.address> (http://your.website)"
] ]
} }
``` ```
@ -40,11 +42,11 @@ requested. :sparkles:
## Creating a pull request ## Creating a pull request
- Open a pull request, and reference the initial issue in the pull request - Open a pull request, and reference the initial issue in the pull request
message (e.g. *fixes #<your-issue-number*). Write a good description and message (e.g. *fixes #<your-issue-number>*). Write a good description and
title, so everybody will know what is fixed/improved. title, so everybody will know what is fixed/improved.
- If it makes sense, add screenshots, gifs etc, so it's easier to see what's - If it makes sense, add screenshots, gifs etc., so it is easier to see what
going on. is going on.
## Wait for feedback ## Wait for feedback
Before accepting your contributions, we will review them. You may get feedback Before accepting your contributions, we will review them. You may get feedback
@ -53,8 +55,10 @@ in your branch and the pull request will be updated automatically.
## Everyone is happy! ## Everyone is happy!
Finally, your contributions will be merged, and everyone will be happy! :smile: Finally, your contributions will be merged, and everyone will be happy! :smile:
Contributions are more than welcome!
Thanks! :sweat_smile: Thanks! :sweat_smile:
[1]: https://github.com/IonicaBizau/git-stats/issues [1]: https://github.com/IonicaBizau/git-stats/issues
[2]: https://github.com/IonicaBizau/code-style [2]: https://github.com/IonicaBizau/code-style