Skip to content

Commit

Permalink
Improved table look/feel and added metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
@riverma
riverma committed Mar 27, 2024
1 parent 4193357 commit a2ca4f1
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/guides/checklist.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ Here we present a checklist you can run through for your project, as well as lin

Review your project's repositories, and ensure all have the following (in prioritized order):

| Checklist Item | Why? | Done? |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- |
| LICENSE | Spell out legal terms for software usage & modification | ✅ or ❌ |
| [README](documentation/readme/) | Provide project overview, setup, & usage instructions | ✅ or ❌ |
| [Contributing Guide](governance/contributions/contributing-guide) | Outline how to contribute & the process for submissions | ✅ or ❌ |
| [Code of Conduct](governance/contributions/code-of-conduct) | Establish community behavior standards | ✅ or ❌ |
| [Issue Templates](governance/contributions/issue-templates/) | Streamline issue reporting for consistency & clarity | ✅ or ❌ |
| [Pull Request Templates](governance/contributions/pull-requests/) | Ensure PRs are comprehensive & adhere to project standards | ✅ or ❌ |
| [Documentation](documentation/documentation-hosts/) | Offer detailed info on features, APIs, & customizations not covered in README | ✅ or ❌ |
| [Change Log](documentation/change-log/) | Keep track of all notable changes in each version in a human-readable format | ✅ or ❌ |
| [Security & Dependency Scanning](software-lifecycle/security/github-security) | Identify vulnerabilities & outdated dependencies for security | ✅ or ❌ |
| [Sensitive Information Scanning](software-lifecycle/security/secrets-detection/) | Detect accidental commits of sensitive info | ✅ or ❌ |
| [Governance Model](governance/governance-model/) | Define decision-making structure & project leadership for transparency & organization | ✅ or ❌ |

| Checklist Item | Why? |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| ✅ LICENSE | Spell out legal terms for software usage & modification |
| ✅ [README](documentation/readme/) | Provide project overview, setup, & usage instructions |
| ✅ [Contributing Guide](governance/contributions/contributing-guide) | Outline how to contribute & the process for submissions |
| ✅ [Code of Conduct](governance/contributions/code-of-conduct) | Establish community behavior standards |
| ✅ [Issue Templates](governance/contributions/issue-templates/) | Streamline issue reporting for consistency & clarity |
| ✅ [Pull Request Templates](governance/contributions/pull-requests/) | Ensure PRs are comprehensive & adhere to project standards |
| ✅ [Documentation](documentation/documentation-hosts/) | Offer detailed info on features, APIs, & customizations not covered in README |
| ✅ [Change Log](documentation/change-log/) | Keep track of all notable changes in each version in a human-readable format |
| ✅ [Security & Dependency Scanning](software-lifecycle/security/github-security) | Identify vulnerabilities & outdated dependencies for security |
| ✅ [Sensitive Information Scanning](software-lifecycle/security/secrets-detection/) | Detect accidental commits of sensitive info |
| ✅ [Governance Model](governance/governance-model/) | Define decision-making structure & project leadership for transparency & organization |
| ✅ [Software Metrics](software-lifecycle/metrics/) | Collect metrics on performance of your software's governance and lifecycle |

## Repository Starter Kit

Expand Down

0 comments on commit a2ca4f1

Please sign in to comment.