siemens / siemens/OOASP

Revise terminology in Interactive Configuration API

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

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The Interactive Configuration API introduced by #5 contains some terminology we want to revise:

  • the term "leaf" or "leaf class" is sometimes not used correctly
  • complete/partial constraints: this naming is not very clear and could be revised if we have a good idea

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 reading the Interactive Configuration API introduced by #5 and trace where “leaf” or “leaf class” and “complete/partial constraints” are used. Done means the terminology choices are agreed and applied consistently across the affected API.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.