Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 2.38 KB

Contributing to Wazuh Indexer Plugins

Depending on the plugin relationship with the Wazuh organization we currently recommend the following naming conventions and optional follow-up checks:

Official plugins

For the official plugins that live within the Wazuh organization (i.e. they are included in wazuh/wazuh-indexer-plugins/ or wazuh/wazuh-indexer-reporting/ folder), and which share the same release cycle as the Wazuh Indexer itself:

  • Do not include the word plugin in the repo name (e.g. job-scheduler)
  • Use lowercase repo names
  • Use spinal case for repo names (e.g. job-scheduler)
  • Do not include the word Wazuh Indexer or Wazuh Dashboard in the repo name
  • Provide a meaningful description, e.g. A Wazuh Dashboard plugin to perform real-time and historical anomaly detection on Wazuh Indexer data.

Thirdparty plugins

For the 3rd party plugins that are maintained as independent projects in separate GitHub repositories with their own release cycles the recommended naming convention should follow the same rules as official plugins with some exceptions and few follow-up checks:

  • Inclusion of the words like Wazuh Indexer or Wazuh Dashboard (and in reasonable cases even plugin) are welcome because they can increase the chance of discoverability of the repository
  • Check the plugin versioning policy is documented and help users know which versions of the plugin are compatible and recommended for specific versions of OpenSearch
  • Review CONTRIBUTING.md document which is by default tailored to the needs of Amazon Web Services developer teams. You might want to update or further customize specific parts related to:
    • Code of Conduct (if you do not already have CoC policy then there are several options to start with, such as Contributor Covenant),
    • Security Policy (you should let users know how they can safely report security vulnerabilities),
    • Check if you need explicit part about Trademarks and Attributions (if you use any registered or non-registered trademarks we recommend following applicable "trademark-use" documents provided by respective trademark owners)