ivuorinen/bbcodeparser
1
0
Fork 0
mirror of https://github.com/ivuorinen/bbcodeparser.git synced 2026-01-26 03:13:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Chore: Fixes to changelog & contributing guide

Browse Source
This commit is contained in:
Ismo Vuorinen
2023-05-03 16:20:42 +03:00
parent 1bcb50a8d6
commit d93bbd5feb
2 changed files with 51 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md
View File

@@ -2,31 +2,40 @@
Contributions are **welcome** and will be fully **credited**.
We accept contributions via Pull Requests on [Github](https://github.com/ivuorinen/bbcodeparser).
We accept contributions via Pull Requests on [GitHub][repo].
## Pull Requests
- **[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).
- **[PSR-2 Coding Standard][psr2]** - The easiest way to apply the conventions
is to install [PHP Code Sniffer][phpcs].
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
- **Document any change in behaviour** - Make sure the `README.md`
and any other relevant documentation are kept up-to-date.
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
- **Consider our release cycle** - We try to follow [SemVer v2][semver].
Randomly breaking public APIs is not an option.
- **Create feature branches** - Don't ask us to pull from your master branch.
- **Create feature branches** - Don't ask us to pull from your main branch.
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **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](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
- **One pull request per feature** - If you want to do more than one
thing, send multiple pull requests.
- **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][git-squash] before submitting.
## Running Tests
``` bash
$ vendor/bin/phpunit
```bash
composer test
```
**Happy coding**!
**Happy coding**!
[repo]: https://github.com/ivuorinen/bbcodeparser
[semver]: https://semver.org
[psr2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer
[git-squash]: https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages