AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO-Config-ACES

Guidelines for incrementing the config part of the version string

Aperta
#104 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
configs
Lingua principale
Python
Stelle
430
Fork
49
Merge medio
18h 5m
PR unite (30g)
1

Descrizione

The name of the configs contains a string with three versions. For example: `cg-config-v1.0.0_aces-v1.3_ocio-v2.1`. It is self-evident what the ACES and OCIO versions should contain but the guidelines for when to increment the config part have not been documented. The following guidelines are proposed as a strawman for further discussion:

Major version increment:
- Adding color spaces
- Adding displays

Minor version increment:
- Adding looks
- Adding new views to existing displays
- Adding named transforms
- Role changes
- Significant changes to existing transforms
- Changes to aliases

Patch version increment:
- Removing color spaces, displays, views, if they are kept in the inactive list
- Minor changes to existing transforms
- Changes to description text
- Changes to family, categories, encoding
- Changes to file_rules or viewing_rules
- Changes to active_displays, active_views, inactive_colorspaces
- Changes to default_view_transform

I'm on the fence about some of these. In many cases it could be a matter of degree (was it a big change or a small change) and so it's difficult to come up with absolutely fixed rules. Therefore, it seems prudent to refer to these as "guidelines" rather than "rules" to indicate that in some cases there will be a judgment call made by the configs working group on how to assign a new version string.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Nell’issue non è indicato alcun file o test; inizia esaminando le categorie major, minor e patch proposte e i commenti sull’issue. Il lavoro è completato quando il configs working group ha risolto le decisioni discrezionali e documentato le linee guida per incrementare la stringa di versione config composta da tre parti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.