chaoss / chaoss/CollectOSS

Define a coding style and document it

Open
#218 0 comments 0 reactions 0 assignees View on GitHub
documentation tech debt
Dominant language
Python
Stars
13
Forks
17
Avg merge
6h 59m
Merged PRs (30d)
1

Description

> [!NOTE]
> Migrated from [augurlabs/augur#3697](https://github.com/augurlabs/augur/issues/3697)
> Originally opened by `@MoralCode` on 2026-02-15

---

We should document our style guide beyond just pylint configs (#197). This would include things like:

How logging should be done (#114 )
How errors should be raised (originally mentioned in https://github.com/chaoss/augur/pull/3695)
how/where to use helper functions and import them
Writing functions such that they are single-purpose (therefore unit testable) and dont require the kitchen sink to be imported at runtime in order to run

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.