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

[DOCUMENTATION] Add dev docs #44

Merged
merged 13 commits into from
Jun 23, 2023
Merged

[DOCUMENTATION] Add dev docs #44

merged 13 commits into from
Jun 23, 2023

Conversation

ElBe-Plaq
Copy link
Member

Description

Added source code documentation.

Closes #42.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change is a documentation update
  • Something else

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new errors or linter warnings
  • My changes generate no problems with other code
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests passed locally with my changes (mkdocs serve)

@ElBe-Plaq ElBe-Plaq added documentation Improvements or additions to the documentation. enhancement Enhancement of an already existing feature. labels Jun 23, 2023
@ElBe-Plaq ElBe-Plaq added this to the Release v1.0.0-alpha3 milestone Jun 23, 2023
@ElBe-Plaq ElBe-Plaq self-assigned this Jun 23, 2023
@mergify mergify bot added the Review requested A review by a core team member is requested. label Jun 23, 2023
@mergify
Copy link
Contributor

mergify bot commented Jun 23, 2023

Checks failed

Checks:

Name Status
MegaLinter
label
CommitCheck

| docs/readthedocs.org:i-language-rust | ❌ |

@github-actions
Copy link

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 4 0 0.18s
✅ BASH bash-exec 1 0 0.03s
✅ BASH shellcheck 1 0 0.06s
⚠️ BASH shfmt 1 1 0.03s
✅ COPYPASTE jscpd yes no 2.16s
✅ CSS stylelint 3 0 1.29s
✅ EDITORCONFIG editorconfig-checker 64 0 0.16s
✅ HTML djlint 1 0 0.74s
⚠️ HTML htmlhint 1 1 0.3s
⚠️ JAVASCRIPT standard 1 1 2.75s
⚠️ MAKEFILE checkmake 1 1 0.03s
⚠️ MARKDOWN markdownlint 34 11 1.14s
⚠️ MARKDOWN markdown-link-check 34 2 7.45s
⚠️ MARKDOWN markdown-table-formatter 34 1 0.34s
✅ REPOSITORY checkov yes no 13.3s
✅ REPOSITORY devskim yes no 0.78s
✅ REPOSITORY dustilock yes no 0.03s
✅ REPOSITORY gitleaks yes no 0.36s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY kics yes no 18.51s
✅ REPOSITORY secretlint yes no 1.12s
✅ REPOSITORY syft yes no 0.35s
✅ REPOSITORY trivy yes no 3.45s
✅ RUST clippy yes no 22.65s
⚠️ SPELL cspell 67 219 23.5s
✅ YAML prettier 15 0 0.99s
✅ YAML v8r 15 0 12.47s
✅ YAML yamllint 15 0 0.5s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@ElBe-Plaq ElBe-Plaq added able to merge Weather the PR is able to merge. approved Changes that got approved by the core team. and removed Review requested A review by a core team member is requested. labels Jun 23, 2023
@mergify mergify bot merged commit 854612f into v1.0.0-alpha3 Jun 23, 2023
6 checks passed
@mergify
Copy link
Contributor

mergify bot commented Jun 23, 2023

Merging pull request

Checks:

Name Status
label
Summary
MegaLinter
pre-commit.ci - pr
docs/readthedocs.org:i-language-rust
CommitCheck

@mergify mergify bot added the Review requested A review by a core team member is requested. label Jun 23, 2023
@delete-merged-branch delete-merged-branch bot deleted the issue-42 branch June 23, 2023 13:10
@ElBe-Plaq ElBe-Plaq linked an issue Oct 19, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
able to merge Weather the PR is able to merge. approved Changes that got approved by the core team. documentation Improvements or additions to the documentation. enhancement Enhancement of an already existing feature. Review requested A review by a core team member is requested. size/L
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DOCUMENTATION] Add dev docs
1 participant