public
nobgit
read
NobMail
Based on mailcow: dockerized
Languages
Repository composition by tracked source files.
PHP
49%
JavaScript
35%
HTML
9%
CSS
4%
Shell
2%
Python
1%
Lua
0%
Perl
0%
Ruby
0%
SCSS
0%
Create file
Wiki Documentation
Clone
https://nobgit.com/orgs/nobgit/nobmail.git
ssh://[email protected]:2222/orgs/nobgit/nobmail.git
Trace
data/web/inc/lib/vendor/stevenmaguire/oauth2-keycloak/CONTRIBUTING.md
Trace helps you understand code history line by line. See who changed each line, when it changed, and which commit introduced it.
Author
Date
Commit
Line
Code
1
# Contributing
3
Contributions are **welcome** and will be fully **credited**.
5
We accept contributions via Pull Requests on [Github](https://github.com/stevenmaguire/oauth2-keycloak).
8
## Pull Requests
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 [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
12
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
14
- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date.
16
- **Consider our release cycle** - We try to follow SemVer. Randomly breaking public APIs is not an option.
18
- **Create topic branches** - Don't ask us to pull from your master branch.
20
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
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.
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.
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.
29
## Running Tests
31
``` bash
32
$ ./vendor/bin/phpunit
33
```
36
## Running PHP Code Sniffer
38
``` bash
39
$ ./vendor/bin/phpcs src --standard=psr2 -sp
40
```
42
**Happy coding**!