Skip to content

Commit 84778a2

Browse files
committed
README updates
1 parent e81c050 commit 84778a2

File tree

5 files changed

+56
-10
lines changed

5 files changed

+56
-10
lines changed

.github/workflows/linter.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ jobs:
1717
- name: Checkout
1818
uses: actions/checkout@v4
1919

20+
- name: Setup PHP
21+
uses: shivammathur/setup-php@v2
22+
with:
23+
php-version: '8.4'
24+
25+
- name: Install dependencies
26+
run: composer install
27+
2028
- name: Run Pint
2129
uses: aglipanci/laravel-pint-action@2.5
2230
with:

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ jobs:
6868
slug: aporat/laravel-cloudwatch-logger
6969

7070
- name: Upload test results to Codecov
71-
if: ${{ !cancelled() }}
71+
if: matrix.coverage == 'xdebug'
7272
uses: codecov/test-results-action@v1
7373
with:
7474
token: ${{ secrets.CODECOV_TOKEN }}

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/thephpleague/oauth2-github).
6+
7+
8+
## Pull Requests
9+
10+
- **[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 [Laravel Pint](https://github.com/laravel/pint).
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow SemVer. Randomly breaking public APIs is not an option.
17+
18+
- **Create topic branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **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 before submitting.
23+
24+
- **Ensure tests pass!** - Please run the tests (see below) before submitting your pull request, and make sure they pass. We won't accept a patch until all tests pass.
25+
26+
- **Ensure no coding standards violations** - Please run PHP Code Sniffer using the PSR-2 standard (see below) before submitting your pull request. A violation will cause the build to fail, so please make sure there are no violations. We can't accept a patch if the build fails.
27+
28+
29+
## Running Tests
30+
31+
``` bash
32+
$ composer test
33+
```
34+
35+
36+
## Running PHP Code Sniffer
37+
38+
``` bash
39+
$ composer check
40+
```
41+
42+
**Happy coding**!

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Laravel CloudWatch Logger
22

33
[![Latest Stable Version](https://img.shields.io/packagist/v/aporat/laravel-cloudwatch-logger.svg?style=flat-square&logo=composer)](https://packagist.org/packages/aporat/laravel-cloudwatch-logger)
4-
[![Latest Dev Version](https://img.shields.io/packagist/vpre/aporat/laravel-cloudwatch-logger.svg?style=flat-square&logo=composer)](https://packagist.org/packages/aporat/laravel-cloudwatch-logger#dev-develop)
54
[![Monthly Downloads](https://img.shields.io/packagist/dm/aporat/laravel-cloudwatch-logger.svg?style=flat-square&logo=composer)](https://packagist.org/packages/aporat/laravel-cloudwatch-logger)
6-
[![Codecov](https://codecov.io/gh/aporat/laravel-cloudwatch-logger/graph/badge.svg?token=0WHTTGMINF)](https://codecov.io/gh/aporat/laravel-cloudwatch-logger)
7-
[![Laravel Version](https://img.shields.io/badge/Laravel-12.x-orange.svg)](https://laravel.com/docs/12.x)
5+
[![Codecov](https://img.shields.io/codecov/c/github/aporat/laravel-cloudwatch-logger?style=flat-square)](https://codecov.io/github/aporat/laravel-cloudwatch-logger)
6+
[![Laravel Version](https://img.shields.io/badge/Laravel-12.x-orange.svg?style=flat-square)](https://laravel.com/docs/12.x)
7+
[![Scrutinizer build (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/build/g/aporat/laravel-cloudwatch-logger?style=flat-square)](https://scrutinizer-ci.com/g/aporat/laravel-cloudwatch-logger/build-status/master)
8+
[![Scrutinizer quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/g/aporat/laravel-cloudwatch-logger?style=flat-square)](https://scrutinizer-ci.com/g/aporat/laravel-cloudwatch-logger/?branch=master)
89
[![License](https://img.shields.io/packagist/l/aporat/laravel-cloudwatch-logger.svg?style=flat-square)](https://github.com/aporat/laravel-cloudwatch-logger/blob/master/LICENSE)
910

1011
A Laravel logging driver for seamless integration with AWS CloudWatch Logs.

composer.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,7 @@
6161
"scripts": {
6262
"test": "phpunit --colors=always",
6363
"test-ci": "phpunit --colors=always --coverage-text --coverage-clover coverage.xml --log-junit junit.xml",
64-
"post-install-cmd": [
65-
"@composer dump-autoload --optimize"
66-
],
67-
"post-update-cmd": [
68-
"@composer dump-autoload --optimize"
69-
]
64+
"check": "vendor/bin/pint --test"
7065
},
7166
"support": {
7267
"issues": "https://github.com/aporat/laravel-cloudwatch-logger/issues",

0 commit comments

Comments
 (0)