openclimatefix / openclimatefix/.github

Add readme

Open
#84 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
1
Forks
11
Avg merge
1m
Merged PRs (30d)
1

Description

Detailed Description

It would be great to have a readme to say how to typically use these.
Some of them are archive, some arent used any more for example

Context

  • good have things clear

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 reviewing the repository contents to determine which community health files “these” refers to and which are archived or unused. Done means adding a README that clearly explains typical usage and distinguishes current files from archived or obsolete ones.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.