Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

17 lines (11 loc) · 1.45 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

  • If you'd like to contribute but don't know where to get started, you can take a look at existing issues.
  • To build the plugin, you'll need Composer. Once you have it installed on your machine, run composer install to get the plugin's dependencies.
  • You can check composer.json for commands you can use to help you work locally.
  • If possible, add Unit Tests alongside any changes you may submit. See the /tests directory for some examples. To run the tests locally, run composer test-php.

License

This plugin is licensed under GNU General Public License v2 (or later).

All materials contributed should be compatible with the GPLv2. This means that if you own the material, you agree to license it under the GPLv2 license. If you are contributing code that is not your own, such as adding a component from another Open Source project, or adding an npm package, you need to make sure you follow these steps:

  1. Check that the code has a license. If you can't find one, you can try to contact the original author and get permission to use, or ask them to release under a compatible Open Source license.
  2. Check the license is compatible with GPLv2, note that the Apache 2.0 license is not compatible.