simonsobs / simonsobs/ocs

Standards and enforcement for aggregator field names, address_root, instance-id.

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

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
19
Forks
7
PR merge metrics
No merged PRs in 30d

Description

We need to document and enforce in code the following sorts of things:

  • agg field names should be drawn from a limited character set (and not include space!)
  • address_root must not contain .
  • instance-id... should be simple too.

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

No files or tests are named; start by locating the code that handles aggregator field names, address_root, and instance-id. Clarify the permitted character sets, then document and enforce them, with tests showing invalid values are rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, distributed-systems
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.