Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation #319

Merged
merged 7 commits into from
Feb 22, 2024
Merged

docs: update documentation #319

merged 7 commits into from
Feb 22, 2024

Conversation

rjaegers
Copy link
Member

@rjaegers rjaegers commented Feb 22, 2024

Several updates to the documentation.

  • Unclutter root directory of the repository by moving community health files to .github
  • Point towards Report content instead of contacting a CODEOWNER
  • Consistently Point towards security policy
  • Add details on PR title and description related to SemVer and Conventional Commits
  • Add PR checklist

@rjaegers rjaegers requested a review from a team as a code owner February 22, 2024 12:01
Copy link
Contributor

github-actions bot commented Feb 22, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 12 0 0.03s
✅ DOCKERFILE hadolint 1 0 0.25s
✅ JSON eslint-plugin-jsonc 8 0 0 3.02s
✅ JSON prettier 8 0 0 0.56s
✅ JSON v8r 8 0 3.87s
✅ MARKDOWN markdownlint 8 0 0 1.12s
✅ MARKDOWN markdown-link-check 8 0 6.39s
✅ MARKDOWN markdown-table-formatter 8 0 0 0.29s
✅ REPOSITORY checkov yes no 14.67s
✅ REPOSITORY gitleaks yes no 0.21s
✅ REPOSITORY git_diff yes no 0.0s
✅ REPOSITORY grype yes no 11.94s
✅ REPOSITORY secretlint yes no 1.39s
✅ REPOSITORY trivy yes no 8.95s
✅ REPOSITORY trivy-sbom yes no 1.57s
✅ REPOSITORY trufflehog yes no 5.58s
✅ SPELL lychee 39 0 1.64s
✅ YAML prettier 14 0 0 1.04s
✅ YAML v8r 14 0 10.53s
✅ YAML yamllint 14 0 0.36s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

Copy link
Contributor

github-actions bot commented Feb 22, 2024

Test Results

18 tests  ±0   18 ✅ ±0   38s ⏱️ -1s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ffea0e8. ± Comparison against base commit 1855dce.

♻️ This comment has been updated with latest results.

Copy link

@BarisTanyeri BarisTanyeri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement!

@rjaegers rjaegers added this pull request to the merge queue Feb 22, 2024
Merged via the queue into main with commit 78baa23 Feb 22, 2024
14 checks passed
@rjaegers rjaegers deleted the feature/update-documentation branch February 22, 2024 15:47
Copy link
Contributor

Pull Request Report (#319)

Static measures

Description Value
Number of added lines 64
Number of deleted lines 12
Number of changed files 7
Number of commits 7
Number of reviews 2
Number of comments (w/o review comments) 2
Number of reviews that contains a comment to resolve 1
Number of reviews that requested a change from the author 0
Number of reviews that approved the Pull Request 1
Get the total number of participants of a Pull Request 3

Time related measures

Description Value
PR lead time (from creation to close of PR) 3.8 Hours
Time that was spend on the branch before the PR was created 1.3 Hours
Time that was spend on the branch before the PR was merged 5 Hours
Time to merge after last review 33.3 Min

Status check related measures

Description Value
Total runtime for last status check run (Workflow for PR) 23.2 Min
Total time spend in last status check run on PR 17.1 Min

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants