{"id":13464713,"url":"https://github.com/pengwynn/flint","last_synced_at":"2025-10-06T13:54:01.664Z","repository":{"id":13015440,"uuid":"15694901","full_name":"pengwynn/flint","owner":"pengwynn","description":"Check your project for common sources of contributor friction.","archived":false,"fork":false,"pushed_at":"2021-02-28T21:24:10.000Z","size":5591,"stargazers_count":1154,"open_issues_count":6,"forks_count":94,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-10-03T21:36:55.501Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pengwynn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-07T04:18:49.000Z","updated_at":"2025-09-24T08:26:25.000Z","dependencies_parsed_at":"2022-07-15T18:00:32.074Z","dependency_job_id":null,"html_url":"https://github.com/pengwynn/flint","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/pengwynn/flint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pengwynn%2Fflint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pengwynn%2Fflint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pengwynn%2Fflint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pengwynn%2Fflint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pengwynn","download_url":"https://codeload.github.com/pengwynn/flint/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pengwynn%2Fflint/sbom","scorecard":{"id":727174,"data":{"date":"2025-08-11","repo":{"name":"github.com/pengwynn/flint","commit":"7de6b195eeac55002976fd9c015bae7e01d2c3fd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":3,"reason":"Found 5/14 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.0.4 not signed: https://api.github.com/repos/pengwynn/flint/releases/781046","Warn: release artifact v0.0.3 not signed: https://api.github.com/repos/pengwynn/flint/releases/155018","Warn: release artifact v0.0.4 does not have provenance: https://api.github.com/repos/pengwynn/flint/releases/781046","Warn: release artifact v0.0.3 does not have provenance: https://api.github.com/repos/pengwynn/flint/releases/155018"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 24 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T13:10:21.916Z","repository_id":13015440,"created_at":"2025-08-22T13:10:21.916Z","updated_at":"2025-08-22T13:10:21.916Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278621837,"owners_count":26017253,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-07-31T14:00:49.131Z","updated_at":"2025-10-06T13:54:01.623Z","avatar_url":"https://github.com/pengwynn.png","language":"Go","funding_links":[],"categories":["Go","Uncategorized","others","📦 Legacy \u0026 Inactive Projects"],"sub_categories":["Uncategorized"],"readme":"# Flint\n\nCheck your project for common sources of contributor friction.\n\n#### For the Non-Developer\n\nFlint checks if your project's folder contains the proper files and structure to allow potential contributors to understand: 1) the project's goals, 2) how to contribute, 3) usage guidelines, and 4) how to install the project.\n\n### Install\n\nIf you've got Go installed, you can install flint with Go's command line\ninterface:\n\n    go get github.com/pengwynn/flint\n\nIf you don't have Go installed, you can download a [prebuilt binary for your\nplatform][releases], optionally renaming it to \"flint\" for convenience.\n\nIf you are on macOS and are using [Homebrew] as package manager you can install\nflint with:\n\n    brew install flint-checker\n\nYou can test your installation by running `flint --version` from any folder.\n\n### Usage\n\nRun `flint` from your project root to check for some common ways to improve the\nexperience for potential contributors. Here's the output for a blank folder to\nshow the full gamut of suggestions:\n\n    ~/projects/dream\n    ❯ flint\n    [ERROR] README not found\n    [INFO] Every project begins with a README. http://bit.ly/1dqUYQF\n    [ERROR] CONTRIBUTING guide not found\n    [INFO] Add a guide for potential contributors. http://git.io/z-TiGg\n    [ERROR] LICENSE not found\n    [INFO] Add a license to protect yourself and your users. http://choosealicense.com/\n    [WARNING] Bootstrap script not found\n    [INFO] A bootstrap script makes setup a snap. http://bit.ly/JZjVL6\n    [WARNING] Test script not found\n    [INFO] Make it easy to run the test suite regardless of project type. http://bit.ly/JZjVL6\n    [CRITICAL] Some critical problems found.\n\nYou can also run this in older projects which were created by lazy you, or by\nyounger, less wise you.\n\nIf you want to check a remote GitHub repository, you can now do so without\ncloning:\n\n    ❯ flint --github pengwynn/dotfiles\n    [ERROR] CONTRIBUTING guide not found\n    [INFO] Add a guide for potential contributors. http://git.io/z-TiGg\n    [WARNING] Test script not found\n    [INFO] Make it easy to run the test suite regardless of project type. http://bit.ly/JZjVL6\n    [CRITICAL] Some critical problems found.\n\nPassing the `-h` flag will show full usage options:\n\n    ❯ flint -h\n    NAME:\n       flint - Check a project for common sources of contributor friction\n    \n    USAGE:\n       flint [global options] command [command options] [arguments...]\n    \n    VERSION:\n       0.0.4\n    \n    COMMANDS:\n       help, h      Shows a list of commands or help for one command\n    \n    GLOBAL OPTIONS:\n       --skip-readme        skip check for README\n       --skip-contributing  skip check for contributing guide\n       --skip-license       skip check for license\n       --skip-bootstrap     skip check for bootstrap script\n       --skip-test-script   skip check for test script\n       --skip-scripts       skip check for all scripts\n       --no-color           skip coloring the terminal output\n       --github, -g         GitHub repository as owner/repo\n       --token, -t          GitHub API access token [$FLINT_TOKEN]\n       --help, -h           show help\n       --version, -v        print the version\n\n### Philosophy\n\nIf you want people to use and contribute to your project, you need to start by\nanswering their most basic questions. Flint is a command line script that will\ncheck your project for common answers to these questions.\n\n#### What is this?\n\nSince it is so important, GitHub founder [Tom Preston-Werner][mojombo]\nsuggests you [should write the README before you write a single line of\ncode][RDD]. A well crafted README includes:\n\n- A description of problems your project solves.\n- The philosophy behind your project.\n- Basic usage and getting started instructions.\n- A list of comparable projects that inspired yours or would be suitable\n  alternatives.\n\n#### How am I allowed to use it?\n\nProviding the source to your project isn't enough. While you don't _have to_\nprovide a license, doing so will make it clear to users and potential\ncontributors how they can legally use your software and what happens to\ncontributions they make. [Choose A License][choose] can help you pick the right\nlicense for your project.\n\n#### How do I contribute?\n\nYou'll want to tell folks about your development workflow so they'll know how\nto submit patches for bugfixes and new features. When you add [CONTRIBUTING\nguidelines][contributing] to your project, GitHub will make those available at\nthe top of every new Pull Request screen.\n\n#### How do I get up and running in development?\n\nA bootstrap script is a thoughtful way to let new users (and future versions of\nyourself on new hardware) get up and running quickly. A good bootstrap script\ndetects and installs all project dependencies. Don't make your less technical\nusers learn devops. Make it as easy as running `script/bootstrap`.\n\n#### How do I make sure my new features didn't break old functionality?\n\nGood software projects have test suites that ensure the code works as\nadvertised. Even within language communities, there can be a myriad of test\nframeworks. You can make it easy to run the test suite with a platform agnostic\n`script/test` executable.\n\n### Maintainers\n\n[@pengwynn][pengwynn]\n\nCopyright 2014 [Wynn Netherland][pengwynn].\n\n[pengwynn]: https://github.com/pengwynn\n[mojombo]: https://github.com/mojombo\n[contributing]: https://github.com/blog/1184-contributing-guidelines\n[octokit contrib]: https://github.com/octokit/octokit.rb/blob/master/CONTRIBUTING.md\n[choose]: http://choosealicense.com/\n[RDD]: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html\n[releases]: https://github.com/pengwynn/flint/releases\n[Homebrew]: https://brew.sh\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpengwynn%2Fflint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpengwynn%2Fflint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpengwynn%2Fflint/lists"}