Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

API version

Aperta
  • Qualcosa non va?
#76 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
cpp
Ambito
api, documentation

Direzione di ricerca

Inizia leggendo l’implementazione esistente di GetAPIVersion e gli header di ofxCore per vedere come viene esposta l’attuale versione dell’API. Esamina il file di versione di primo livello suggerito dalla proposta, quindi individua gli aggiornamenti richiesti per l’header, la documentazione, la nota di rilascio, la compatibilità, l’host e il plug-in. Per considerare completato il lavoro, sono necessari l’accordo del sottocomitato identificato e codice e documentazione firmati in una pull request.

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

Descrizione

standard change

Open Effects Proposal for Standard Change

Please read the contribution guidelines first.

Standard Change Workflow

  • [X ] Create proposal as issue (you're doing this now!)
  • [ X] Tag this issue with standard change tag
  • Identify subcommittee: at least one plug-in vendor, and at least one host
  • Discuss the idea in this issue
  • Write new or updated code and doc
  • Publish updates as a pull request (ideally on a feature/PROPOSAL-NAME branch)
    • Make sure that PR references this issue number to keep them in sync
    • Discuss and review code in the PR
    • Meet all requirements below for accepting PR
  • When subcommittee signs off and other members don't have any further review comments,
    maintainer merges PR to master which closes PR and issue

Requirements for accepting a standard change:

  • Header files updated
  • Documentation updated
  • Release notes added
  • Compatibility review completed
  • Working code demonstrated with at least one host and one plugin
  • At least two members sign off
  • No further changes requested from membership

Summary

We don't define explicitely the API version as a string at least anywhere. We do have GetAPIVersion but it's not clear it's being properly updated/referred to.

Motivation

Although API version should not be a conditional for compliance, it's a good practice when adding features in API to mark the version this was added with context.

Problem

Adds an explicit version string. Suggestion is to add "1.5" in ofxCore and a top level text file with sub-version, e.g. 1.5.5, for each API update. The sub-version would be used to in parallel update the wiki entry with Issue/PR number. This way a developer can see what was added since they last downloaded master and at a glance understand what matters to them.

Impact

Provides a way to source API version in non-ambiguous manner.

Documentation Impact

When you google the version displayed would be auto-accurate.

Stakeholders

All

Discussion

Lingua principale
C++
Stelle
579
Fork
155
Merge medio
1g 18m
PR unite (30g)
13

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di AcademySoftwareFoundation/openfx

Tutte le issue di AcademySoftwareFoundation/openfx

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.