{"id":13391192,"url":"https://github.com/lappleapple/feedmereadmes","last_synced_at":"2025-05-16T12:03:51.896Z","repository":{"id":112522110,"uuid":"81590157","full_name":"LappleApple/feedmereadmes","owner":"LappleApple","description":"Free README editing+feedback to make your open source projects grow. See the README maturity model to help you keep going.","archived":false,"fork":false,"pushed_at":"2023-03-20T09:34:12.000Z","size":111,"stargazers_count":1128,"open_issues_count":12,"forks_count":51,"subscribers_count":37,"default_branch":"master","last_synced_at":"2024-10-15T04:02:44.726Z","etag":null,"topics":["docs","documentation","feedback","product-development","project-manager","readme","readme-first","user-friendly","writer"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LappleApple.png","metadata":{"files":{"readme":"README-maturity-model.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-02-10T17:41:08.000Z","updated_at":"2024-09-21T23:29:00.000Z","dependencies_parsed_at":"2023-05-15T15:15:51.746Z","dependency_job_id":null,"html_url":"https://github.com/LappleApple/feedmereadmes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LappleApple%2Ffeedmereadmes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LappleApple%2Ffeedmereadmes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LappleApple%2Ffeedmereadmes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LappleApple%2Ffeedmereadmes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LappleApple","download_url":"https://codeload.github.com/LappleApple/feedmereadmes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219845139,"owners_count":16556452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","feedback","product-development","project-manager","readme","readme-first","user-friendly","writer"],"created_at":"2024-07-30T15:00:36.079Z","updated_at":"2024-10-15T04:03:36.976Z","avatar_url":"https://github.com/LappleApple.png","language":null,"funding_links":[],"categories":["Tools"],"sub_categories":[],"readme":"## README Maturity Model\n\nThis isn't scientific, but meant to offer a little guidance.\n\n### Level One: \"The Code is the Documentation\"\n- No/almost no README text of any sort.\n- No installation, configuration, running details.\n- No developer documentation.\n- No complementary files, such as contributor guidelines.\n- No build status information, so there's no insight into the project's current state.\n- No suggested average response time to issues and/or pull requests.\n- No badges showing code coverage or other quality metrics.\n- What text is available may be obsolete or non-priority.\n\n**Recommendation**: Sometimes developers post personal projects and experiments that aren't ready-to-share. In these cases, having little to no documentation may be acceptable. We recommend that the README indicates the nature/status of the project. For example, warn users that \"this project is experimental/personal, so use at your own risk.\"\n\n### Level Two: Bare-Minimum README\n- Limited information about the project's functionality and purpose.\n- Basic installation, configuration, running details for users, but untested and incomplete.\n- Basic or no developer documentation.\n- A line in the README about contributions, but no dedicated file.\n- A line about the project's build status, though it may be obsolete; or no build status information.\n- A line about the average response time to issues and/or pull requests.\n- No badges showing code coverage or other quality metrics.\n- The text is infrequently updated and may be obsolete or inaccurate.\n\n**Recommendation**: A Level Two README aims for a broad audience, but its incompleteness causes frustration and wasted effort. Sometimes this is worse than having no documentation at all. Include a note stating whether the project is early-stage, unstable, experimental or personal.\n\n### Level Three: Basic README\n- Some detailed information about the project's functionality, usefulness and purpose.\n- Basic installation, configuration, running details for users, tested and complete.\n- Basic documentation for potential contributors.\n- A vision statement or project roadmap for onboarding new contributors.\n- A Contributing.md/.rst file with basic information.\n- A line about the project's build status, but minimal: \"under development\" or \"stable.\"\n- A line about the average response time to issues and/or pull requests.\n- At least one badge showing code coverage or other quality metrics.\n- Text updated at monthly or quarterly intervals, so inaccuracies may exist.\n\n**Recommendation**: A Level Three README is thorough enough to support small-scale community growth. Early-stage projects requiring contributor development should aim to reach this level before publication. Widespread project adoption can happen, although the README might pose barriers.\n\n### Level Four: README with purpose\n- Detailed information about the project's purpose, functionality and special features/attributes.\n- Detailed user installation, configuration, and running instructions that may or may not be recently updated; information about common errors and how to resolve them.\n- Detailed documentation for potential contributors.\n- A detailed vision statement or project roadmap for onboarding new contributors.\n- A Contributing.md/.rst file with detailed style guidelines.\n- The build status identifies specific aspects of the project that are incomplete and/or causing instability.\n- Clear information about the average response time to issues and/or pull requests.\n- One or more badges showing code coverage or other quality metrics.\n- Text updated at monthly or quarterly intervals, so inaccuracies may exist.\n\n**Recommendation**: A Level Four README can support large-scale community usage and growth. It might lack some ingredients necessary for achieving widespread use and adoption. Corporations that impose stringent standards for adoption might hesitate before using it.\n\n### Level Five: Product-oriented README\n- Detailed information about the project's purpose, functionality and special features/attributes, so that the reader can immediately understand the usefulness and impact of its features and attributes.\n- User testimonials and evidence of past performance in real development situations.\n- Detailed user installation, configuration, and running instructions, tested and current; information about common errors and how to resolve them.\n- Detailed documentation for potential contributors.\n- A detailed vision statement or project roadmap for onboarding new contributors.\n- Embedded visual aids like diagrams and demos.\n- A Contributing.md/.rst file with detailed style guidelines.\n- The build status identifies specific project aspects that are incomplete and/or causing instability.\n- Clear information about the average response time to issues and/or pull requests.\n- One or more badges showing code coverage or other quality metrics.\n- Text updated at weekly or even daily intervals, so inaccuracies are unlikely.\n\n**Recommendation**: Level Five READMEs usually emerge from projects with broad contributor/user bases. Their detail reinforces production-ready use and supervised contributions. Every project should aspire to this level of documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flappleapple%2Ffeedmereadmes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flappleapple%2Ffeedmereadmes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flappleapple%2Ffeedmereadmes/lists"}