File tree Expand file tree Collapse file tree 2 files changed +54
-0
lines changed
Expand file tree Collapse file tree 2 files changed +54
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing to php-jwk
2+
3+ This is a very small library with a very limited scope but if you want to contribute please feel free to do so.
4+
5+ ## How can I contribute?
6+
7+ ### Reporting bugs
8+
9+ You can open [ a new issue] ( https://github.com/Strobotti/php-jwk/issues ) once you have checked one covering your issue hasn't been opened yet.
10+
11+ ### Open a pull-request
12+
13+ If you want to fix a bug or add a missing feature you can open a new pull-request.
14+
15+ Please note that you need a PHP 7.2 or later for using this library (including running the tests).
16+
17+ Basic steps:
18+
19+ 1 . Fork this repository
20+ 1 . Clone it locally
21+ 1 . Install dependencies with Composer
22+ ``` bash
23+ composer install
24+ ```
25+ 1. Create a branch on your fork
26+ 1. Commit & push
27+ 1. Open a pull-request from your branch
28+ 1. Profit
29+
30+ Some guidelines:
31+
32+ 1. Before committing make sure to format the code accordingly:
33+ ` ` ` bash
34+ make php-cs-fixer-fix
35+ ` ` `
36+ 1. Also make sure the tests pass successfully and you have sufficient coverage
37+ ` ` ` bash
38+ make test-unit
39+ ` ` `
40+
41+ # ## Git Commit Messages
42+
43+ * Use the present tense (" Add feature" not " Added feature" )
44+ * Use the imperative mood (" Move cursor to..." not " Moves cursor to..." )
45+ * Limit the first line to 72 characters or less
46+
47+ # # License
48+
49+ [MIT](https://github.com/Strobotti/php-jwk/blob/master/LICENSE)
Original file line number Diff line number Diff line change 11# php-jwk
22
3+ [ ![ Build Status] ( https://travis-ci.com/Strobotti/php-jwk.svg?branch=master )] ( https://travis-ci.com/Strobotti/php-jwk )
34[ ![ codecov] ( https://codecov.io/gh/Strobotti/php-jwk/branch/master/graph/badge.svg )] ( https://codecov.io/gh/Strobotti/php-jwk )
45
56A small PHP library to handle JWKs (Json Web Keys)
@@ -120,3 +121,7 @@ lq2ybzcLh3zyhCitBOebiRWDQfG26EH9lTlJhll+p/Dg8vAXxJLIJ4SNLcqgFeZe
120121xwIDAQAB
121122-----END PUBLIC KEY-----
122123```
124+
125+ ### Contributing
126+
127+ See [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for more details.
You can’t perform that action at this time.
0 commit comments