diff --git a/CHANGELOG.md b/CHANGELOG.md index 527a59a..1512636 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,79 +7,92 @@ All Notable changes to `ivuorinen\BBCodeParser` will be documented in this file. - Project now in new hands - Tests -# Changelog of `Golonka\BBCodeParser` +## Changelog of `Golonka\BBCodeParser` ## v2.2.0 - 2015-09-07 ### Added -- You can now strip all BBCode tags by using the ``stripBBCodeTags`` function. + +- You can now strip all BBCode tags by using the `stripBBCodeTags` function. ## v2.1.0 - 2015-06-20 ### Added -- Made ``parseCaseSensitive`` and ``parseCaseInsensitive`` functions to make parsing more readable. + +- Made `parseCaseSensitive` and `parseCaseInsensitive` functions to make parsing more readable. ## v2.0.0 - 2015-06-02 ### Added + - Using PSR-4 instead of PSR-0 -- Moved the ``arrayOnly`` and ``arrayExcept`` functions into a trait +- Moved the `arrayOnly` and `arrayExcept` functions into a trait - Minimum supported PHP version bumped to 5.4 ### Fixed + - Renamed some tag names, mostly making them all lowercase - - `` underLine -> underline `` - - `` lineThrough -> linethrough `` - - `` fontSize -> size `` - - `` fontColor -> color `` - - `` namedQuote -> namedquote `` - - `` namedQuote -> namedquote `` - - `` namedLink -> namedlink `` - - `` orderedListNumerical -> orderedlistnumerical `` - - `` orderedListAlpha -> orderedlistalpha `` - - `` unorderedList -> unorderedlist `` - - `` listItem -> listitem `` + - `underLine -> underline` + - `lineThrough -> linethrough` + - `fontSize -> size` + - `fontColor -> color` + - `namedQuote -> namedquote` + - `namedQuote -> namedquote` + - `namedLink -> namedlink` + - `orderedListNumerical -> orderedlistnumerical` + - `orderedListAlpha -> orderedlistalpha` + - `unorderedList -> unorderedlist` + - `listItem -> listitem` ### Removed -- The ``iterate`` property is removed. Unneeded after improvements in parsing method. -- Removed deprecated tags ``[ul]`` and ``[ol]`` + +- The `iterate` property is removed. Unneeded after improvements in parsing method. +- Removed deprecated tags `[ul]` and `[ol]` ## v1.4 - 2015-05-05 ### Added + - Optional parameter enables or disables case insensitivity. Disabled by default. ## v1.3.0 - 2014-06-30 ### Fixed + - The only/except functionally have been broken since like 1.1, but now it´s working. Better late then never! ## v1.2.7 - 2014-05-19 ### Added + - A new iterate key is added to tags that typically could contain more tags of the same kind, like quotes. ### Fixed + - Problem where tags of the same kind would just parse the top level. ## v1.2.6 - 2014-05-17 ### Fixed + - Fixed a problem where if a tag had a line break in them they wouldn't parse. ## v1.2.5 - 2014-05-15 ### Fixed + - Improved most regex matches by removing unnecessary greediness. ## v1.2.0 - 2014-03-25 ### Fixed + - Better syntax for lists. ## v1.1.0 - 2014-01-27 ### Added + - Support for custom bbcode tags. ## v1.0.0 - 2013-11-07 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f564977..42c5ee5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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**! \ No newline at end of file +[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