Skip to content

Commit 4ac7418

Browse files
committed
Updated various internal docs, and README
1 parent 98b5c02 commit 4ac7418

File tree

4 files changed

+33
-7
lines changed

4 files changed

+33
-7
lines changed

Diff for: CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,23 @@ You can then update by simply running:
5656

5757
### Running tests
5858

59+
#### Locally
60+
5961
We use PHPUnit to run tests. Simply run `composer install` and a symlink `phpunit` should be located in the `bin` directory.
6062

6163
Next, run `bin/phpunit` and the rest will be taken care of. Upon any pull requests and merges, TravisCI will check the code to ensure all test suites pass.
6264

6365
For quicker tests, be sure to disable coverage with `bin/php --no-coverage`.
6466

67+
#### Actions
68+
69+
We also utilize Github Actions. Currently it will:
70+
71+
1. Pull the package
72+
2. Test the package against a matrix of PHP and Laravel Versions
73+
3. Confirm coding styling is good
74+
4. Updates coverage results
75+
6576
-----
6677

6778
Thats it! Enjoy.

Diff for: CONTRIBUTORS.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
osiset
33
darrynten
44
amosmos
5-
ilamp
65
jedimdan
6+
ilamp
77
tuimz
88
oanhnn
99
seka19
@@ -13,8 +13,8 @@ ncpope
1313
ericnkatz
1414
dellow
1515
c4l3b
16+
awebartisan
1617
mat-dropshipspy
18+
florinsith
1719
dhritimanrick
1820
baorv
19-
awebartisan
20-
ImgBotApp"

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (C) 2019 Tyler King <[email protected]>
1+
Copyright (C) 2020 Tyler King <[email protected]>
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
44

Diff for: README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,30 @@ For internal documentation, it is [available here](https://osiset.com/laravel-sh
5555

5656
If you have found a bug or would like to request a feature for discussion, please use the `ISSUE_TEMPLATE` in this repo when creating your issue. Any issue submitted without this template will be closed.
5757

58-
## LICENSE
58+
## License
5959

6060
This project is released under the MIT [license](https://github.com/osiset/laravel-shopify/blob/master/LICENSE).
6161

6262
## Misc
6363

64-
### Contributors
64+
### Repoistory
6565

66-
Contibutors are updated each release, pulled from Github API. See `CONTRIBUTORS.txt`.
66+
#### Contributors
67+
68+
Contibutions are always welcome! Contibutors are updated each release, pulled from Github. See `CONTRIBUTORS.txt`.
69+
70+
If you're looking to become a contributor, please see `CONTRIBUTING.md`.
71+
72+
#### Maintainers
73+
74+
Maintainers are users who manage the repository itself, wheather its managing the issues, assisting in releases, or helping with pull requests.
75+
76+
Currently this repository is maintained by:
77+
78+
- @osiset
79+
- @kyon147
80+
81+
Looking to become a maintainer? E-mail @osiset directly.
6782

6883
### Special Note
6984

0 commit comments

Comments
 (0)