[Repolinter] Tier 1 Repository Hygiene Issue
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Start by reading CONTRIBUTING.md and README.md, then review the Repolinter results for the four missing sections. Add the requested building dependencies and project-building guidance to CONTRIBUTING.md, and the development lifecycle and local-development guidance to README.md. Rerun Repolinter and confirm these checks pass.
Written by the indexing model from the issue text.
Description
Repolinter Report
This report was generated automatically by the Repolinter.
This Repolinter run generated the following results:
| ❗ Error | ❌ Fail | ⚠️ Warn | ✅ Pass | Ignored | Total |
|---|---|---|---|---|---|
| 0 | 2 | 2 | 36 | 23 | 63 |
- Fail
- ❌
contributing-contains-building-dependencies - ❌
contributing-contains-building-the-project
- ❌
- Warning
- ⚠️
readme-contains-development-and-software-delivery-lifecycle - ⚠️
readme-contains-local-development
- ⚠️
- Passed
- ✅
license-file-exists - ✅
security-file-exists - ✅
readme-file-exists - ✅
contributing-file-exists - ✅
license-contains-license - ✅
security-contains-security-and-responsible-disclosure-policy - ✅
readme-contains-about-the-project - ✅
readme-contains-project-mission - ✅
readme-contains-agency-mission - ✅
readme-contains-team-mission - ✅
readme-contains-core-team - ✅
readme-contains-documentation-index - ✅
readme-contains-repository-structure - ✅
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 - ✅
readme-contains-glossary - ✅
readme-contains-policies - ✅
readme-contains-open-source-policy - ✅
readme-contains-security-and-responsible-disclosure-policy - ✅
readme-contains-public-domain - ✅
contributing-contains-how-to-contribute - ✅
contributing-contains-getting-started - ✅
contributing-contains-workflow-and-branching - ✅
contributing-contains-testing-conventions - ✅
contributing-contains-coding-style-and-linters - ✅
contributing-contains-writing-issues - ✅
contributing-contains-documentation - ✅
contributing-contains-policies - ✅
contributing-contains-open-source-policy - ✅
contributing-contains-security-and-responsible-disclosure-policy - ✅
contributing-contains-public-domain
- ✅
- Ignored
maintainers-file-existscodeowners-file-existsgovernance-file-existscommunity-guidelines-file-existscode-of-conduct-file-existsreadme-contains-project-visionreadme-contains-governancecontributing-contains-team-specific-guidelinescontributing-contains-writing-pull-requestscontributing-contains-reviewing-pull-requestscontributing-contains-shipping-releasesmaintainers-contains-maintainersmaintainers-contains-maintainers-listmaintainers-contains-approvers-listmaintainers-contains-reviewers-listgovernance-contains-governancecode-owners-contains-list-of-userscode-owners-contains-repo-domainscommunity-guidelines-contains-principlescommunity-guidelines-contains-community-guidelinescommunity-guidelines-contains-acknowledgementscode-of-conduct-contains-contributor-code-of-conductcode-of-conduct-contains-acknowledgements
Fail #
❌ contributing-contains-building-dependencies #
Doesn't contain Building dependencies (CONTRIBUTING.md).
❌ contributing-contains-building-the-project #
Doesn't contain Building the Project (CONTRIBUTING.md).
Warning #
Click to see rules
⚠️ 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).
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).
✅ 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-project-mission #
Contains Project Mission (README.md).
✅ readme-contains-agency-mission #
Contains Agency Mission (README.md).
✅ readme-contains-team-mission #
Contains Team Mission (README.md).
✅ readme-contains-core-team #
Contains Core Team (README.md).
✅ readme-contains-documentation-index #
Contains Documentation Index (README.md).
✅ readme-contains-repository-structure #
Contains Repository Structure (README.md).
✅ readme-contains-coding-style-and-linters #
Contains Coding Style and Linters (README.md).
✅ readme-contains-branching-model #
Contains Branching Model (README.md).
✅ readme-contains-contributing #
Contains Contributing (README.md).
✅ readme-contains-codeowners #
Contains Codeowners (README.md).
✅ readme-contains-community #
Contains Community (README.md).
✅ readme-contains-community-guidelines #
Contains Community Guidelines (README.md).
✅ readme-contains-feedback #
Contains Feedback (README.md).
✅ readme-contains-glossary #
Contains Glossary (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).
✅ contributing-contains-how-to-contribute #
Contains How to Contribute (CONTRIBUTING.md).
✅ contributing-contains-getting-started #
Contains Getting Started (CONTRIBUTING.md).
✅ contributing-contains-workflow-and-branching #
Contains Workflow and Branching (CONTRIBUTING.md).
✅ contributing-contains-testing-conventions #
Contains Testing Conventions (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-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).
Ignored #
Click to see rules
maintainers-file-exists #
This rule was ignored for the following reason: ignored because level is "off"
codeowners-file-exists #
This rule was ignored for the following reason: ignored because level is "off"
governance-file-exists #
This rule was ignored for the following reason: ignored because level is "off"
community-guidelines-file-exists #
This rule was ignored for the following reason: ignored because level is "off"
code-of-conduct-file-exists #
This rule was ignored for the following reason: ignored because level is "off"
readme-contains-project-vision #
This rule was ignored for the following reason: ignored because level is "off"
readme-contains-governance #
This rule was ignored for the following reason: ignored because level is "off"
contributing-contains-team-specific-guidelines #
This rule was ignored for the following reason: ignored because level is "off"
contributing-contains-writing-pull-requests #
This rule was ignored for the following reason: ignored because level is "off"
contributing-contains-reviewing-pull-requests #
This rule was ignored for the following reason: ignored because level is "off"
contributing-contains-shipping-releases #
This rule was ignored for the following reason: ignored because level is "off"
maintainers-contains-maintainers #
This rule was ignored for the following reason: ignored because level is "off"
maintainers-contains-maintainers-list #
This rule was ignored for the following reason: ignored because level is "off"
maintainers-contains-approvers-list #
This rule was ignored for the following reason: ignored because level is "off"
maintainers-contains-reviewers-list #
This rule was ignored for the following reason: ignored because level is "off"
governance-contains-governance #
This rule was ignored for the following reason: ignored because level is "off"
code-owners-contains-list-of-users #
This rule was ignored for the following reason: ignored because level is "off"
code-owners-contains-repo-domains #
This rule was ignored for the following reason: ignored because level is "off"
community-guidelines-contains-principles #
This rule was ignored for the following reason: ignored because level is "off"
community-guidelines-contains-community-guidelines #
This rule was ignored for the following reason: ignored because level is "off"
community-guidelines-contains-acknowledgements #
This rule was ignored for the following reason: ignored because level is "off"
code-of-conduct-contains-contributor-code-of-conduct #
This rule was ignored for the following reason: ignored because level is "off"
code-of-conduct-contains-acknowledgements #
This rule was ignored for the following reason: ignored because level is "off"
- Dominant language
- Shell
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
docs(agents): strengthen the no-backslash-escaped-backticks rule with an issue-creation example Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
oSoWoSo/vOid_Community_repOsitory#148 · 1 comment ·
-
chore
Difficulty 1/5 Under an hour Newbie friendliness 91/100
alunduil/alunduil-chezmoi#792 ·
-
area: compat bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
zenhub-dev
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
OpenLiberty/ci.docker#747 ·