line / line/centraldogma-python
Use dedicated `Revision` type instead of primitive int
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 21
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Currently, a revision is represented as an int.
https://github.com/line/centraldogma-python/blob/6098f1afe6b181388ab32bd7f91161dd7bd2a70d/centraldogma/dogma.py#L140
It would be nice to use a dedicated type introduced in #14
https://github.com/line/centraldogma-python/blob/6098f1afe6b181388ab32bd7f91161dd7bd2a70d/centraldogma/data/revision.py#L20-L34
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with centraldogma/dogma.py around line 140 and read centraldogma/data/revision.py lines 20-34 to understand the existing Revision type. Locate the revision values still represented as int and update the relevant uses so the client consistently exposes Revision rather than a primitive integer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100