Skip to content

Commit 4acd53b

Browse files
committed
update readme and GH files
1 parent fc29c2a commit 4acd53b

File tree

8 files changed

+82
-63
lines changed

8 files changed

+82
-63
lines changed

Diff for: .github/CONTRIBUTING.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
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.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[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](https://pear.php.net/package/PHP_CodeSniffer).
44+
45+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46+
47+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48+
49+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50+
51+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52+
53+
- **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](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54+
55+
**Happy coding**!

Diff for: .github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/cmgmyr/laravel-messenger/discussions/new?category=q-a
5+
about: Ask the community for help
6+
- name: Request a feature
7+
url: https://github.com/cmgmyr/laravel-messenger/discussions/new?category=ideas
8+
about: Share ideas for new features
9+
- name: Report a security issue
10+
url: https://github.com/cmgmyr/laravel-messenger/security/policy
11+
about: Learn how to notify us for sensitive bugs
12+
- name: Report a bug
13+
url: https://github.com/cmgmyr/laravel-messenger/issues/new
14+
about: Report a reproducable bug

Diff for: .github/SECURITY.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security Policy
2+
3+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Diff for: .github/stale.yml

-26
This file was deleted.

Diff for: .github/workflows/run-tests-mysql.yml

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
name: Laravel Messenger - MySQL Tests
2-
on:
3-
push:
4-
branches:
5-
- master
6-
- develop
7-
- feature/**
8-
pull_request:
9-
branches:
10-
- master
11-
- develop
2+
3+
on: [push, pull_request]
124

135
jobs:
146
laravel-tests:

Diff for: .github/workflows/run-tests-postgres.yml

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
name: Laravel Messenger - PostgreSQL Tests
2-
on:
3-
push:
4-
branches:
5-
- master
6-
- develop
7-
- feature/**
8-
pull_request:
9-
branches:
10-
- master
11-
- develop
2+
3+
on: [push, pull_request]
124

135
jobs:
146
laravel-tests:

Diff for: .github/workflows/run-tests.yml

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
name: Laravel Messenger - Tests
2-
on:
3-
push:
4-
branches:
5-
- master
6-
- develop
7-
- feature/**
8-
pull_request:
9-
branches:
10-
- master
11-
- develop
2+
3+
on: [push, pull_request]
124

135
jobs:
146
laravel-tests:

Diff for: readme.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,13 @@ class User extends Authenticatable {
119119
* [WIP] [Lumen API](https://github.com/cmgmyr/lumen-messenger-api)
120120

121121

122-
## Contributing?
123-
Please format your code before creating a pull-request. This will format all files as specified in `.php_cs`:
122+
## Contributing
124123

125-
```
126-
vendor/bin/php-cs-fixer fix .
127-
```
124+
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
128125

129-
## Security
126+
## Security Vulnerabilities
130127

131-
If you discover any security related issues, please email [Chris Gmyr](mailto:[email protected]) instead of using the issue tracker.
128+
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
132129

133130
## Credits
134131

0 commit comments

Comments
 (0)