ladybug-tools / ladybug-tools/community

Suggestions that could be added to the read me for this repo

Open
#1 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
No language data
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

This repo is a general starting-off space for the Ladybug Tools collaboration. Items may include:

  • Sandbox code and comments pre-repo stage - but that might otherwise clutter an existing repo
  • Issues and comments that might apply to multiple repos
  • Style guides and standards that might apply to multiple projects
  • General coding or technical issues not related to specific projects such as
    • Calendars
    • FAQs
    • Utilities

Items for this repo should allow for aging and archiving so as to prevent a clutter of old, no longer used stuff

  • Aging and archiving
    • Use year folders for last years things no longer
  • Deprecation
    • Links to forks with newer versions

This repo does not replace:

  • End user discussion on the Discourse Forum
  • Project coding matters in their respective repos
  • ladybug-tools.github.io for home page code and assets of wide utility and long duration such as logos and licenses

Any other fun ideas to add?

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

Review the repository README and the issue's proposed scope, including aging, archiving, deprecation, calendars, FAQs, and utilities. Identify which suggestions are still relevant and define a focused README change with a clear completion point; the issue does not name a specific file or test.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.