OpenwaterHealth / OpenwaterHealth/openlifu-python

Good Open Source Hygiene to Improve Community Collaboration

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

Nobody has claimed this yet.

Dominant language
Python
Stars
27
Forks
21
Avg merge
1d 20m
Merged PRs (30d)
6

Description

Did quick audit and in interest of helping the project in OS hygiene and helping with CYA on your future contributions as you grow, could be expanded for all repos under org:

  1. Could Use a CodeOwners file to help external parties know who to contact; example: https://github.com/IntersectMBO/osc-documentation/blob/master/CODEOWNERS
  2. Should expand and make a contributing.md file that shows how people can better participate: https://github.com/IntersectMBO/cardano-node/blob/master/CONTRIBUTING.md
  3. Need a Security md file for reporting vulnerabilities safely if any; example: https://github.com/cardano-scaling/mithril/blob/main/SECURITY.md
  4. Easy to include code of conduct related to engagements: https://github.com/IntersectMBO/osc-documentation/blob/master/CODE_OF_CONDUCT.md
  5. Something to consider for CYA even though you're using AGPL 3, while somewhat permissive license doesn't exclude the need for having a contributor license agreement completely, example: https://opensource.google/documentation/reference/cla/
  6. Ease of access also I would include a PR and Issues template, helps later down the road and for contributors putting them in.
  7. Also for security of your project, I would enable content reports, its very helpful for workflow management
Image

Contributor guide

Open the contributing guide

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's current GitHub metadata and the linked CODEOWNERS, CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md examples. Clarify which recommendations apply to openlifu-python versus all organization repositories, then define the agreed files, templates, reporting settings, and any CLA decision as complete.

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.