Merge pull request OleksiiBulba#6 from OleksiiBulba/chore/impovements-2

Chore: package improvements

Author: OleksiiBulba

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Updated
+- Updated README.md;
+
 ## [1.0] - 2022-12-14
 
 ### Updated

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by [email][author-email].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[author-email]: mailto:[email protected]
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [GitHub][github-pull-requests].
+
+
+## Pull Requests
+
+- **[PSR-12 Extended Coding Style][link-psr-12]** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests** -- Your patch will not be accepted if it does not have tests.
+
+- **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][link-semver-website]. Randomly breaking public APIs is not an option.
+
+- **Create feature branches** -- Don't ask us to pull from your master 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][link-git-squash-tutorial] before submitting.
+
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+**Happy coding**!
+
+[github-pull-requests]: https://github.com/OleksiiBulba/webpack-encore-plugin/pulls
+[link-psr-12]: https://www.php-fig.org/psr/psr-12/
+[link-semver-website]: http://semver.org/
+[link-git-squash-tutorial]: http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages

README.md

@@ -97,6 +97,7 @@ composer test
 ## Contributing
 
 Please feel free to open pull request or create an issue, they are more than welcome!
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
 
 ## Security
 

composer.json

@@ -26,12 +26,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Boo\\WebpackEncorePlugin\\": "src"
+            "OleksiiBulba\\WebpackEncorePlugin\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Boo\\WebpackEncorePlugin\\Tests\\Unit\\": "tests/unit"
+            "OleksiiBulba\\WebpackEncorePlugin\\Tests\\Unit\\": "tests/unit"
         }
     },
     "config": {

src/Asset/EntrypointLookup.php

@@ -9,10 +9,10 @@
  * file that was distributed with this source code.
  */
 
-namespace Boo\WebpackEncorePlugin\Asset;
+namespace OleksiiBulba\WebpackEncorePlugin\Asset;
 
-use Boo\WebpackEncorePlugin\Exception\EntrypointNotFoundException;
-use Boo\WebpackEncorePlugin\WebpackEncorePluginConfigurationInterface;
+use OleksiiBulba\WebpackEncorePlugin\Exception\EntrypointNotFoundException;
+use OleksiiBulba\WebpackEncorePlugin\WebpackEncorePluginConfigurationInterface;
 use Symfony\Component\Serializer\Encoder\DecoderInterface;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;

src/Asset/EntrypointLookupInterface.php

@@ -9,9 +9,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Boo\WebpackEncorePlugin\Asset;
+namespace OleksiiBulba\WebpackEncorePlugin\Asset;
 
-use Boo\WebpackEncorePlugin\Exception\EntrypointNotFoundException;
+use OleksiiBulba\WebpackEncorePlugin\Exception\EntrypointNotFoundException;
 
 interface EntrypointLookupInterface
 {

src/Exception/EntrypointNotFoundException.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Boo\WebpackEncorePlugin\Exception;
+namespace OleksiiBulba\WebpackEncorePlugin\Exception;
 
 class EntrypointNotFoundException extends \InvalidArgumentException
 {

src/TagRenderer/TagRenderer.php

@@ -9,9 +9,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Boo\WebpackEncorePlugin\TagRenderer;
+namespace OleksiiBulba\WebpackEncorePlugin\TagRenderer;
 
-use Boo\WebpackEncorePlugin\Asset\EntrypointLookupInterface;
+use OleksiiBulba\WebpackEncorePlugin\Asset\EntrypointLookupInterface;
 
 class TagRenderer implements TagRendererInterface
 {

src/TagRenderer/TagRendererInterface.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Boo\WebpackEncorePlugin\TagRenderer;
+namespace OleksiiBulba\WebpackEncorePlugin\TagRenderer;
 
 interface TagRendererInterface
 {