mayadata-io / mayadata-io/mayadata-charts

update contributor documentation

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
2
Forks
5
PR merge metrics
No merged PRs in 30d

Description

  • description, website and tags
  • add code-of-conduct, license
  • readme: add description of the project (high level overview of different charts hosted here)
  • readme: links to specific charts ( kubera, kubera-enterprise, openebs-enterprise)?
  • readme : install / usage instructions
  • readme : user documentation link
  • repo level ci
  • additional details on each of specific charts
  • NOTICE.md, license scan for dependencies.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by auditing the repository README, chart directories, existing contributor files, and repository-level CI configuration against the checklist. Confirm what is missing for the project overview, chart links, installation and usage instructions, user documentation, chart details, NOTICE.md, licensing, and dependency scanning; done means each checklist item is addressed and the documentation is consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.