Skip to content

Commit 180e915

Browse files
committed
refactor: fix format
1 parent da979e3 commit 180e915

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,25 @@ Welcome to the Code-Pushup Community Plugins repository! This space is designed
77
To maintain high quality and usability standards, please ensure your plugin meets the following criteria before submission:
88

99
### 1. Documentation
10+
1011
- Your code must be well-documented
1112
- Include clear descriptions of functionality and usage
1213
- Provide API documentation where applicable
1314
- Provide a readme file in the root of your plugin, determining the plugin name, description, and usage instructions
1415

1516
### 2. Testing Coverage
17+
1618
- Implement comprehensive unit tests
1719
- Include integration tests
1820
- Maintain good test coverage metrics
1921

2022
### 3. Code Quality
23+
2124
- Code must be properly linted
2225
- It must be formatted too
2326

2427
### 4. Examples
28+
2529
- Include an `examples` directory in your plugin
2630
- Provide at least one `basic-setup` example
2731
- Ensure examples are:
@@ -30,7 +34,6 @@ To maintain high quality and usability standards, please ensure your plugin meet
3034
- Demonstrate core functionality
3135
- Well-documented with setup instructions
3236

33-
3437
For reference, you can find plugins examples in our [CLI repository](https://github.com/code-pushup/cli/tree/main/packages), including plugins for ESLint, TypeScript, JSDoc, Lighthouse, and more. These can serve as templates for your own plugin implementation.
3538

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

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Code-Pushup is a tool that helps you measure and track your code quality metrics
1313
## Available Plugins
1414

1515
This section will list community plugins as they are added. Each plugin will include:
16+
1617
- Brief description
1718
- Installation instructions
1819
- Basic usage example
@@ -21,6 +22,7 @@ This section will list community plugins as they are added. Each plugin will inc
2122
## Creating Your Own Plugin
2223

2324
Want to contribute? Great! You can create your own plugin and share it with the community. Check out our [CONTRIBUTING.md](./CONTRIBUTING.md) guide for:
25+
2426
- Minimum requirements
2527
- Development guidelines
2628
- Submission process

0 commit comments

Comments
 (0)