Skip to content

Commit 28a3f9f

Browse files
committed
Updated docs
1 parent a00d923 commit 28a3f9f

4 files changed

Lines changed: 166 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:
2+
3+
So, you want to contribute to this project! That's awesome. However, before
4+
doing so, please read the following simple steps how to contribute. This will
5+
make the life easier and will avoid wasting time on things which are not
6+
requested. :sparkles:
7+
8+
## Discuss the changes before doing them
9+
- First of all, open an issue in the repository, using the [bug tracker][1],
10+
describing the contribution you would like to make, the bug you found or any
11+
other ideas you have. This will help us to get you started on the right
12+
foot.
13+
14+
- If it makes sense, add the platform and software information (e.g. operating
15+
system, Node.JS version etc.), screenshots (so we can see what you are
16+
seeing).
17+
18+
- It is recommended to wait for feedback before continuing to next steps.
19+
However, if the issue is clear (e.g. a typo) and the fix is simple, you can
20+
continue and fix it.
21+
22+
## Fixing issues
23+
- Fork the project in your account and create a branch with your fix:
24+
`some-great-feature` or `some-issue-fix`.
25+
26+
- Commit your changes in that branch, writing the code following the
27+
[code style][2]. If the project contains tests (generally, the `test`
28+
directory), you are encouraged to add a test as well. :memo:
29+
30+
- If the project contains a `package.json` or a `bower.json` file add yourself
31+
in the `contributors` array (or `authors` in the case of `bower.json`;
32+
if the array does not exist, create it):
33+
34+
```json
35+
{
36+
"contributors": [
37+
"Your Name <and@email.address> (http://your.website)"
38+
]
39+
}
40+
```
41+
42+
## Creating a pull request
43+
44+
- Open a pull request, and reference the initial issue in the pull request
45+
message (e.g. *fixes #<your-issue-number>*). Write a good description and
46+
title, so everybody will know what is fixed/improved.
47+
48+
- If it makes sense, add screenshots, gifs etc., so it is easier to see what
49+
is going on.
50+
51+
## Wait for feedback
52+
Before accepting your contributions, we will review them. You may get feedback
53+
about what should be fixed in your modified code. If so, just keep committing
54+
in your branch and the pull request will be updated automatically.
55+
56+
## Everyone is happy!
57+
Finally, your contributions will be merged, and everyone will be happy! :smile:
58+
Contributions are more than welcome!
59+
60+
Thanks! :sweat_smile:
61+
62+
63+
64+
[1]: https://github.com/IonicaBizau/bloggify-github-login/issues
65+
66+
[2]: https://github.com/IonicaBizau/code-style

DOCUMENTATION.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Documentation
2+
3+
You can see below the API reference of this module.
4+
5+
### `bloggifyGithubLogin(a, b)`
6+
Login with GitHub for Bloggify.
7+
8+
#### Params
9+
- **Number** `a`: Param descrpition.
10+
- **Number** `b`: Param descrpition.
11+
12+
#### Return
13+
- **Number** Return description.
14+

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016-17 Ionică Bizău <bizauionica@gmail.com> (http://ionicabizau.net)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
2+
# bloggify-github-login
3+
4+
[![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][patreon] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bloggify-github-login.svg)](https://www.npmjs.com/package/bloggify-github-login) [![Downloads](https://img.shields.io/npm/dt/bloggify-github-login.svg)](https://www.npmjs.com/package/bloggify-github-login) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
5+
6+
> Login with GitHub for Bloggify.
7+
8+
## :cloud: Installation
9+
10+
```sh
11+
$ npm i --save bloggify-github-login
12+
```
13+
14+
15+
## :clipboard: Example
16+
17+
18+
19+
```js
20+
const bloggifyGithubLogin = require("bloggify-github-login");
21+
22+
console.log(bloggifyGithubLogin());
23+
```
24+
25+
## :memo: Documentation
26+
27+
28+
### `bloggifyGithubLogin(a, b)`
29+
Login with GitHub for Bloggify.
30+
31+
#### Params
32+
- **Number** `a`: Param descrpition.
33+
- **Number** `b`: Param descrpition.
34+
35+
#### Return
36+
- **Number** Return description.
37+
38+
39+
40+
## :yum: How to contribute
41+
Have an idea? Found a bug? See [how to contribute][contributing].
42+
43+
44+
## :moneybag: Donations
45+
46+
Another way to support the development of my open-source modules is
47+
to [set up a recurring donation, via Patreon][patreon]. :rocket:
48+
49+
[PayPal donations][paypal-donations] are appreciated too! Each dollar helps.
50+
51+
Thanks! :heart:
52+
53+
54+
## :scroll: License
55+
56+
[MIT][license] © [Ionică Bizău][website]
57+
58+
[patreon]: https://www.patreon.com/ionicabizau
59+
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
60+
[donate-now]: http://i.imgur.com/6cMbHOC.png
61+
62+
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2016#license-mit
63+
[website]: http://ionicabizau.net
64+
[contributing]: /CONTRIBUTING.md
65+
[docs]: /DOCUMENTATION.md

0 commit comments

Comments
 (0)