Contributing

Please do feel free to open an Issue for any bugs or issues you find, or even a Pull Request with solutions 😎

Likewise, I am very open to new feature Pull Requests!

GitHub Discussions

I have enabled Discussions on this repository, so if you have any questions, suggestions or just want to chat about this plugin, please feel free to start a discussion.

Install Git Pre-Commit hooks

Please do this if you are intending to submit a PR. It will check commits locally before they are pushed up to the Repo.

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

This will ensure that all code meets the required linting standard before being committed.

Run pre-commit manually

You can run these checks manually on all staged files using the below command :

poe pre

Update the Documentation if required

If you have added or changed functionality, please Update the documentation also. This is a pre-req to having a PR merged. See Documentation for instructions

Contribution Workflow

1. Fork this Repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Write your code, ensuring it is covered by new tests if applicable and documentation.
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request