source-cooperative / source-cooperative/source.coop
[Proposed Feature] Lint for readme/product best practices
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 26
- Forks
- 9
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 42
Description
Description of Feature: Lint to see if all data product metadata/readme best practices pieces are being fulfilled (see https://github.com/source-cooperative/docs.source.coop/issues/12)
What value is this feature adding to Source Cooperative? Make sure metadata/readmes are descriptive and helpful to a user.
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.
Research direction
Start by reading the linked docs.source.coop issue 12 to identify the metadata and README best practices the lint should check. Then inspect the source.coop project to find its existing lint or validation entry points. Done means the project can detect whether data product metadata and README requirements are fulfilled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100