Riot: como lidar com as mudanças da API?

Criado em 3 jun. 2016 · 6Comentários · Fonte: RIOT-OS/RIOT

atualmente, algumas (não todas) de nossas mudanças de API são anunciadas na lista de discussão e algumas (não todas) são mencionadas nas notas de lançamento.

Existe uma maneira de otimizar isso?

Ideias:

_todas_ as alterações de API precisam ser anunciadas na lista de e-mails, com um assunto claro ("API CHANGE em foo_bar ()" e um corpo de mensagem explicando como corrigir o código legado,
criamos um arquivo API_CHANGES no repo, e todos os commits de alteração de API contêm as informações acima?

Ou mantê-lo como está - tentar informar razoavelmente a multidão de alguma forma?

RFC stale

Fonte

kaspar030

Todos 6 comentários

Não tenho certeza se precisamos do arquivo, mas os anúncios para a lista de e-mails são certamente uma boa ideia.

miri64 em 3 jun. 2016

(por outro lado, espero que estejamos chegando a um ponto em breve, onde as mudanças de API são algo que acontece raramente ;-))

miri64 em 3 jun. 2016

Otimista. ;-)

OlegHahm em 3 jun. 2016

Eu sugeriria o versionamento de APIs para que os usuários de uma API sejam notificados no momento da compilação quando precisarem atualizar seu código devido a uma alteração na API.

ou seja, algo na linha de (paciência - não testado):
my_api.h

#define MY_API_VERSION 4711
#if MY_API_VERSION_USED != MY_API_VERSION
#error my_api version does not match used version
#endif
...

usercode.c

#define MY_API_VERSION_USED 23
#include "my_api.h"
...

LudwigKnuepfer em 4 jun. 2016

👎2 👍1

Este problema foi marcado automaticamente como obsoleto porque não teve atividades recentes. Ele será fechado se nenhuma outra atividade ocorrer. Se você quiser que eu ignore esse problema, marque-o com o rótulo "Estado: não desatualize". Obrigado por suas contribuições.