Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.49 KB

Contributing to Code-Pushup Community Plugins

Welcome to the Code-Pushup Community Plugins repository! This space is designed for the community to create, share, and publish their own plugins. We're excited to see your contributions.

Minimum Requirements for Plugin Submissions

To maintain high quality and usability standards, please ensure your plugin meets the following criteria before submission:

1. Documentation

  • Your code must be well-documented
  • Include clear descriptions of functionality and usage
  • Provide API documentation where applicable
  • Provide a readme file in the root of your plugin, determining the plugin name, description, and usage instructions

2. Testing Coverage

  • Implement comprehensive unit tests
  • Include integration tests
  • Maintain good test coverage metrics

3. Code Quality

  • Code must be properly linted
  • It must be formatted too

4. Examples

  • Include an examples directory in your plugin
  • Provide at least one basic-setup example
  • Ensure examples are:
    • Easy to reproduce
    • Quick to execute
    • Demonstrate core functionality
    • Well-documented with setup instructions

For reference, you can find plugins examples in our CLI repository, including plugins for ESLint, TypeScript, JSDoc, Lighthouse, and more. These can serve as templates for your own plugin implementation.

We look forward to your contributions! If you have any questions, feel free to open an issue for discussion.