-
Notifications
You must be signed in to change notification settings - Fork 10
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
Repolinter Results #226
Repolinter Results #226
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs a second pair of eyes in case we want to include any language within the newly made sections
@sachin-panayil I'll take care of filling in the sections! |
@natalialuzuriaga sounds good! would you want to work off this branch so it all goes out in one PR or do you want to work on in separately? if you want to do it separately, ill merge now 👍 |
@sachin-panayil I'll work on this branch!! |
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
@sachin-panayil @decause-gov Finished updating documentation so we'll be ready for setting up repo-scaffolder releases, feel free to review now. There are a couple of minor missing items, however these can be addressed later when more of the work is done: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is great work and is really indepth @natalialuzuriaga !! ready to ship 🚢
Next Steps
Add Missing Information to the Documents
When viewing the changes of this Pull Request, files and sections have been added in order to bring this repository up to standards.
Using either this GitHub page or an IDE, please fill in the section with the proper information that is missing.
The body of the section will provide context and examples of how it should be filled out.
The raw results of the repolinter can be found below.
Repolinter Results
# Repolinter ReportThis report was generated automatically by the Repolinter.
This Repolinter run generated the following results:
maintainers-file-exists
community-guidelines-file-exists
code-of-conduct-file-exists
readme-contains-core-team
readme-contains-documentation-index
readme-contains-repository-structure
readme-contains-development-and-software-delivery-lifecycle
readme-contains-local-development
readme-contains-coding-style-and-linters
readme-contains-branching-model
readme-contains-contributing
readme-contains-codeowners
readme-contains-community
readme-contains-community-guidelines
readme-contains-feedback
contributing-contains-team-specific-guidelines
contributing-contains-testing-conventions
contributing-contains-writing-pull-requests
code-owners-contains-repo-domains
governance-file-exists
readme-contains-project-vision
readme-contains-project-mission
readme-contains-agency-mission
readme-contains-team-mission
readme-contains-governance
readme-contains-glossary
contributing-contains-shipping-releases
license-file-exists
security-file-exists
readme-file-exists
contributing-file-exists
codeowners-file-exists
license-contains-license
security-contains-security-and-responsible-disclosure-policy
readme-contains-about-the-project
readme-contains-policies
readme-contains-open-source-policy
readme-contains-security-and-responsible-disclosure-policy
readme-contains-public-domain
readme-contains-sbom
contributing-contains-how-to-contribute
contributing-contains-getting-started
contributing-contains-building-dependencies
contributing-contains-building-the-project
contributing-contains-workflow-and-branching
contributing-contains-coding-style-and-linters
contributing-contains-writing-issues
contributing-contains-reviewing-pull-requests
contributing-contains-documentation
contributing-contains-policies
contributing-contains-open-source-policy
contributing-contains-security-and-responsible-disclosure-policy
contributing-contains-public-domain
maintainers-contains-maintainers
maintainers-contains-maintainers-list
maintainers-contains-approvers-list
maintainers-contains-reviewers-list
governance-contains-governance
code-owners-contains-list-of-users
community-guidelines-contains-principles
community-guidelines-contains-community-guidelines
community-guidelines-contains-acknowledgements
code-of-conduct-contains-contributor-code-of-conduct
code-of-conduct-contains-acknowledgements
Fail #
❌
maintainers-file-exists
#Did not find a file matching the specified patterns. (
{docs/,.github/,}MAINTAINERS.md
).❌
community-guidelines-file-exists
#Did not find a file matching the specified patterns. (
{docs/,.github/,}COMMUNITY_GUIDELINES.md
).❌
code-of-conduct-file-exists
#Did not find a file matching the specified patterns. (
{docs/,.github/,}CODE_OF_CONDUCT.md
).❌
readme-contains-core-team
#Doesn't contain Core Team (
README.md
).❌
readme-contains-documentation-index
#Doesn't contain Documentation Index (
README.md
).❌
readme-contains-repository-structure
#Doesn't contain Repository Structure (
README.md
).❌
readme-contains-development-and-software-delivery-lifecycle
#Doesn't contain Development and Software Delivery Lifecycle (
README.md
).❌
readme-contains-local-development
#Doesn't contain Local Development (
README.md
).❌
readme-contains-coding-style-and-linters
#Doesn't contain Coding Style and Linters (
README.md
).❌
readme-contains-branching-model
#Doesn't contain Branching Model (
README.md
).❌
readme-contains-contributing
#Doesn't contain Contributing (
README.md
).❌
readme-contains-codeowners
#Doesn't contain Codeowners (
README.md
).❌
readme-contains-community
#Doesn't contain Community (
README.md
).❌
readme-contains-community-guidelines
#Doesn't contain Community Guidelines (
README.md
).❌
readme-contains-feedback
#Doesn't contain Feedback (
README.md
).❌
contributing-contains-team-specific-guidelines
#Doesn't contain Team Specific Guidelines (
CONTRIBUTING.md
).❌
contributing-contains-testing-conventions
#Doesn't contain Testing Conventions (
CONTRIBUTING.md
).❌
contributing-contains-writing-pull-requests
#Doesn't contain Writing Pull Requests (
CONTRIBUTING.md
).❌
code-owners-contains-repo-domains
#Doesn't contain documentation | frontend | backend | Repo Domains (
CODEOWNERS.md
).Warning #
Click to see rules
governance-file-exists
#Did not find a file matching the specified patterns. (
{docs/,.github/,}GOVERNANCE.md
).readme-contains-project-vision
#Doesn't contain Project Vision (
README.md
).readme-contains-project-mission
#Doesn't contain Project Mission (
README.md
).readme-contains-agency-mission
#Doesn't contain Agency Mission (
README.md
).readme-contains-team-mission
#Doesn't contain Team Mission (
README.md
).readme-contains-governance
#Doesn't contain Governance (
README.md
).readme-contains-glossary
#Doesn't contain Glossary (
README.md
).contributing-contains-shipping-releases
#Doesn't contain Shipping Releases (
CONTRIBUTING.md
).Passed #
Click to see rules
✅
license-file-exists
#Found file (
LICENSE
).✅
security-file-exists
#Found file (
SECURITY.md
).✅
readme-file-exists
#Found file (
README.md
).✅
contributing-file-exists
#Found file (
CONTRIBUTING.md
).✅
codeowners-file-exists
#Found file (
CODEOWNERS.md
).✅
license-contains-license
#Contains license (
LICENSE
).✅
security-contains-security-and-responsible-disclosure-policy
#Contains Security and Responsible Disclosure Policy (
SECURITY.md
).✅
readme-contains-about-the-project
#Contains About the Project (
README.md
).✅
readme-contains-policies
#Contains Policies (
README.md
).✅
readme-contains-open-source-policy
#Contains Open Source Policy (
README.md
).✅
readme-contains-security-and-responsible-disclosure-policy
#Contains Security and Responsible Disclosure Policy (
README.md
).✅
readme-contains-public-domain
#Contains Public domain (
README.md
).✅
readme-contains-sbom
#Contains Software Bill of Materials (
README.md
).✅
contributing-contains-how-to-contribute
#Contains How to Contribute (
CONTRIBUTING.md
).✅
contributing-contains-getting-started
#Contains Getting Started (
CONTRIBUTING.md
).✅
contributing-contains-building-dependencies
#Contains Building dependencies (
CONTRIBUTING.md
).✅
contributing-contains-building-the-project
#Contains Building the Project (
CONTRIBUTING.md
).✅
contributing-contains-workflow-and-branching
#Contains Workflow and Branching (
CONTRIBUTING.md
).✅
contributing-contains-coding-style-and-linters
#Contains Coding Style and Linters (
CONTRIBUTING.md
).✅
contributing-contains-writing-issues
#Contains ISSUE_TEMPLATE.md | Issues (
CONTRIBUTING.md
).✅
contributing-contains-reviewing-pull-requests
#Contains Reviewing Pull Requests (
CONTRIBUTING.md
).✅
contributing-contains-documentation
#Contains Documentation (
CONTRIBUTING.md
).✅
contributing-contains-policies
#Contains Policies (
CONTRIBUTING.md
).✅
contributing-contains-open-source-policy
#Contains Open Source Policy (
CONTRIBUTING.md
).✅
contributing-contains-security-and-responsible-disclosure-policy
#Contains Security and Responsible Disclosure Policy (
CONTRIBUTING.md
).✅
contributing-contains-public-domain
#Contains Public domain (
CONTRIBUTING.md
).✅
maintainers-contains-maintainers
#Did not find file matching the specified patterns. (
{docs/,.github/,}MAINTAINERS.md
).✅
maintainers-contains-maintainers-list
#Did not find file matching the specified patterns. (
{docs/,.github/,}MAINTAINERS.md
).✅
maintainers-contains-approvers-list
#Did not find file matching the specified patterns. (
{docs/,.github/,}MAINTAINERS.md
).✅
maintainers-contains-reviewers-list
#Did not find file matching the specified patterns. (
{docs/,.github/,}MAINTAINERS.md
).✅
governance-contains-governance
#Did not find file matching the specified patterns. (
{docs/,.github/,}GOVERNANCE.md
).✅
code-owners-contains-list-of-users
#Contains Code Owners (
CODEOWNERS.md
).✅
community-guidelines-contains-principles
#Did not find file matching the specified patterns. (
{docs/,.github/,}COMMUNITY_GUIDELINES.md
).✅
community-guidelines-contains-community-guidelines
#Did not find file matching the specified patterns. (
{docs/,.github/,}COMMUNITY_GUIDELINES.md
).✅
community-guidelines-contains-acknowledgements
#Did not find file matching the specified patterns. (
{docs/,.github/,}COMMUNITY_GUIDELINES.md
).✅
code-of-conduct-contains-contributor-code-of-conduct
#Did not find file matching the specified patterns. (
{docs/,.github/,}CODE_OF_CONDUCT.md
).✅
code-of-conduct-contains-acknowledgements
#Did not find file matching the specified patterns. (
{docs/,.github/,}CODE_OF_CONDUCT.md
).