Skip to content

Commit

Permalink
chore: format
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Jan 11, 2025
1 parent b5e5cb6 commit 8596019
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/community.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Build
run: npm run build
- name: Test community report
run: node dist/core/cli.js community ctrf-reports/ctrf-report.json example --title "Community report"
run: node dist/core/cli.js community ctrf-reports/ctrf-report.json summary-short --title "Community report"
- name: Upload test results
uses: actions/upload-artifact@v4
with:
Expand Down
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,13 +273,14 @@ your workflow:

### Generating a Community Built Report

To use a community built report, add the `community` command to
your workflow and the name of the report template:
To use a community built report, add the `community` command to your workflow
and the name of the report template:

```yaml
- name: Publish CTRF Community Report
run:
npx github-actions-ctrf community path-to-your-ctrf-report.json report-template-name
npx github-actions-ctrf community path-to-your-ctrf-report.json
report-template-name
if: always()
```

Expand Down Expand Up @@ -548,33 +549,43 @@ For inspiration on what you can create, check out the

### Community Reports

We welcome and encourage contributions of community-built reports. Community reports allow users to share custom Handlebars templates designed for specific use cases or unique report styles.
We welcome and encourage contributions of community-built reports. Community
reports allow users to share custom Handlebars templates designed for specific
use cases or unique report styles.

#### How to Contribute a Community Report

1. **Fork the Repository**
Start by forking this repository to your GitHub account.

2. **Create a New Report Folder**
Navigate to the `community-reports` directory and create a new folder named after your report (e.g., `my-custom-report`).
Navigate to the `community-reports` directory and create a new folder named
after your report (e.g., `my-custom-report`).

3. **Include the Following Files**
Your report folder should include:
- **`my-custom-report.hbs`**: Your Handlebars template file. This is the core of your report.
- **`README.md`**: Documentation about your report. Include the following details:

- **`my-custom-report.hbs`**: Your Handlebars template file. This is the core
of your report.
- **`README.md`**: Documentation about your report. Include the following
details:
- The purpose of your template.
- Instructions on how to use it.
- Any important considerations (e.g., required CTRF report properties).
- Example output

4. **Submit a Pull Request**
Once your report is ready, submit a pull request with a brief description of your contribution. We will review it and provide feedback if necessary.
Once your report is ready, submit a pull request with a brief description of
your contribution. We will review it and provide feedback if necessary.

#### Guidelines for Creating a Good Community Report

- **Be Descriptive**: Ensure your `README.md` clearly explains the report's purpose, usage, and any special requirements.
- **Follow the Template Structure**: Maintain consistency with other community reports in the repository.
- **Keep It Useful**: Focus on templates that solve common problems or address specific needs.
- **Be Descriptive**: Ensure your `README.md` clearly explains the report's
purpose, usage, and any special requirements.
- **Follow the Template Structure**: Maintain consistency with other community
reports in the repository.
- **Keep It Useful**: Focus on templates that solve common problems or address
specific needs.

## Calculations

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@
"handlebars": "^4.7.8",
"yargs": "^17.7.2"
}
}
}

0 comments on commit 8596019

Please sign in to comment.