Skip to content

Commit e7f2834

Browse files
committed
added recommended community files
1 parent 88f27c1 commit e7f2834

File tree

3 files changed

+81
-3
lines changed

3 files changed

+81
-3
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Release Notes
2+
3+
All important changes will be documented in this file.
4+
5+
## v1.0.0 (2018-02-24)
6+
7+
- Initial release
8+
9+
## v1.0.1 (2018-02-25)
10+
11+
- Use unsigned integer to user_id column ([941ce78](https://github.com/mayoz/laravel-tokens/commit/941ce78b56412c9bec65fdc402e6dc3703ad82b8))
12+
- Added custom token generator ([88f27c1](https://github.com/mayoz/laravel-tokens/commit/88f27c1342b3db529e1b992e35889b9da9650daa))

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contribution Guide
2+
3+
Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.
4+
5+
## Etiquette
6+
7+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
8+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
9+
extremely unfair for them to suffer abuse or anger for their hard work.
10+
11+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
12+
world that developers are civilized and selfless people.
13+
14+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
15+
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
16+
17+
## Viability
18+
19+
When requesting or submitting new features, first consider whether it might be useful to others. Open
20+
source projects are used by many developers, who may have entirely different needs to your own. Think about
21+
whether or not your feature is likely to be used by other users of the project.
22+
23+
## Procedure
24+
25+
Before filing an issue:
26+
27+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
28+
- Check to make sure your feature suggestion isn't already present within the project.
29+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
30+
- Check the pull requests tab to ensure that the feature isn't already in progress.
31+
32+
Before submitting a pull request:
33+
34+
- Check the codebase to ensure that your feature doesn't already exist.
35+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
36+
37+
## Requirements
38+
39+
If the project maintainer has any additional requirements, you will find them listed here.
40+
41+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
42+
43+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
44+
45+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
46+
47+
- **Consider our release cycle** - We try to follow [semver](http://semver.org/). Randomly breaking public APIs is not an option.
48+
49+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
50+
51+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
52+
53+
**Happy coding**!

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ This package provides a simple solution for give multiple token to your applicat
1212

1313
This package is for Laravel 5.5 and above.
1414

15-
1615
## Installation
1716

1817
You can install the package via composer using:
@@ -50,7 +49,6 @@ php artisan vendor:publish --provider="Mayoz\Token\TokenServiceProvider" --tag="
5049

5150
If you need you are free to change your `config` file.
5251

53-
5452
## Implementation
5553

5654
After installation, you can implement the new feature for your application.
@@ -98,7 +96,6 @@ And finally, you will add the new guard to your application. Open the `config/au
9896

9997
Congratulations!
10098

101-
10299
## Usage
103100

104101
When you need it (after login or any actions later), use the helper function to create a new token.
@@ -207,3 +204,19 @@ composer require ramsey/uuid
207204
```
208205

209206
Cheers.
207+
208+
### Changelog
209+
210+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
211+
212+
## Contributing
213+
214+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
215+
216+
## Security Vulnerabilities
217+
218+
If you discover any security related issues, please create a new issue with using the "Bug" label. All security vulnerabilities will be promptly addressed.
219+
220+
## License
221+
222+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)