Nesta página

Contribuir com o protocolo¶

A manutenção do Legible também começa pelo que alguém percebe e consegue formular, seja num teste que deu trabalho, numa explicação que não se sustenta ou numa condição que o projeto ignorou.

Questões às quais você pode acrescentar algo¶

Você pode investigar um ponto que encontrou no uso: uma explicação difícil de entender, uma condição ausente da especificação, uma troca de arquivos trabalhosa ou uma necessidade de configuração. Pode também formular outra questão. Não é preciso esperar que os mantenedores criem uma tarefa.

Você pode apresentar uma crítica, um relato, uma correção de texto ou código sem precisar resolver o problema inteiro. Leia o material pertinente e as propostas acessíveis nos repositórios do projeto no GitHub. Apresente sua observação, as incertezas e a evidência que pode compartilhar. Uma nota ou relato já pode iniciar a conversa; Appoints, Traces e Nods não são exigidos para enviar uma correção.

Relatar uma experiência¶

Ao relatar uma experiência, explique o que tentou fazer, qual ferramenta ou modelo usou e onde o percurso ajudou ou exigiu esforço. Se comparou com seu modo habitual, descreva o que mudou, distinguindo o que observou do que ainda suspeita e compartilhando apenas os trechos necessários e autorizados.

Em uma colaboração, considere as duas pessoas. A preparação ficou mais fácil para quem enviou, mas a leitura tomou mais tempo de quem recebeu? Foi necessário explicar novamente algo que o registro deveria conter? Esse tipo de relato orienta melhorias no texto, nas instruções e nos componentes.

Discutir e corrigir os materiais¶

Indique a página, a seção e a edição. Cite o trecho e explique sua objeção ou mudança sugerida. Críticas ao livro e ao artigo podem ser discutidas independentemente do código. Se a proposta mudar uma regra do protocolo, descreva o efeito nos formatos, na interpretação e nos testes.

Desenvolver código e configurações¶

Consulte os componentes existentes antes de começar. Uma integração pode evoluir sem mudar a especificação. Inclua um exemplo que permita reproduzir o comportamento acrescentado ou corrigido, com versões, dependências e acessos necessários.

Preservar, apresentar e incorporar¶

Uma proposta pode vir acompanhada de um rascunho de genealogia ou de registros Legible pertinentes. Um Appoint permite declarar uma formulação; um Trace, a relação de dependência com outros trabalhos; um Nod, uma consequência já recebida. Esses registros são opcionais: você pode apresentar uma proposta sem emitir nenhum deles.

No GitHub, você pode abrir uma issue para iniciar a discussão. Para sugerir alterações nos arquivos, envie um pull request, que apresenta as mudanças para revisão dos mantenedores. Tanto o rascunho quanto os registros pertinentes podem acompanhar esse envio. A issue e o pull request não são, por si só, registros Legible.

Os mantenedores decidem o que incorporam. Essa seleção não invalida outras formulações nem demonstra que receberam uma consequência. Para continuar uma linha não incorporada, conserve os arquivos e referências que pode manter. Leitores interessados precisam consultar também as propostas em discussão; baixar o branch principal não inclui os arquivos de PRs não incorporados.

Os links para os repositórios e suas Issues aparecem ao final desta página. Os relatos e as propostas são enviados pelo GitHub.

Participar da manutenção¶

Você pode começar por revisões, documentação ou correções e indicar interesse em manter um componente. Responsabilidades e permissões são combinadas conforme a colaboração se estabelece. Os mantenedores revisam o que será incorporado aos repositórios e ao site. As propostas independentes também têm um caminho de publicação.

Licença e publicação da contribuição¶

Ao enviar material para incorporação, confirme que pode disponibilizá-lo sob a licença do destino. Textos usam CC BY 4.0; código e formatos originais, Apache-2.0. Preserve os avisos de terceiros. Se um texto serve apenas à discussão e não está sendo oferecido para incorporação, informe isso. Os autores conservam seus direitos sob essas licenças.

Informar que um texto serve apenas à discussão esclarece que ele não está sendo oferecido para incorporação aos arquivos do projeto. Se você o publicar em uma Issue pública do GitHub, outras pessoas poderão lê-lo e a publicação estará sujeita aos Termos de Serviço do GitHub. Se essas condições não forem adequadas ao material, combine outro meio de envio com os mantenedores antes de compartilhá-lo.

O envio a um repositório público torna o conteúdo acessível nesse ambiente. Confirme os direitos e autorizações necessários para disponibilizá-lo sob a licença aplicável. Contribuições podem permanecer no histórico Git e em cópias de terceiros; removê-las da versão atual não elimina automaticamente essas cópias. Para pedir uma correção ou a retirada de conteúdo publicado pelo projeto, envie uma mensagem aos mantenedores pelo canal de contato indicado no site. Não é necessário criar ou assinar um registro Legible para fazer esse pedido. A retirada da publicação não revoga automaticamente licenças já concedidas; consulte as notas de publicação para as condições e os limites desse processo.

Enviar uma correção não exige preparar Appoint, Trace ou Nod. A publicação de registros, nomes exibidos no site ou contatos tem revisão e seleção próprias. Consulte as notas de publicação.

Ao oferecer código ou textos para incorporação¶

Os três repositórios adotam a DCO 1.1 e exigem assinatura criptográfica dos commits. Depois de ler a certificação e revisar o que está enviando, use git commit -sS: -s acrescenta o sign-off Signed-off-by, e -S assina o commit. Nome e e-mail do sign-off ficam públicos; configure um endereço adequado para esse uso antes de fazer o commit.

A DCO trata da legitimidade de oferecer o material sob a licença pertinente; não transfere seus direitos autorais ao projeto nem substitui a NCO dos registros Legible. Publicar um registro ou uma referência não altera a licença do trabalho ou da evidência citada. Questões de divulgação e dados pessoais exigem exame próprio, inclusive quando a preparação teve auxílio de IA.

Perguntas, críticas e discussões não exigem DCO nem registros Legible. Você pode apresentar um pull request apenas para discutir uma proposta, mas, antes de incorporar as alterações, os mantenedores precisam conferir o sign-off da DCO, as assinaturas dos commits e as permissões de uso do material enviado. Consulte as políticas completas de protocol e website, além da política de livros e artigos.

Canais¶

O canal para dúvidas, relatos de uso e propostas é o GitHub Issues. Escolha o repositório conforme o assunto:

Uma issue permite apresentar a questão e conversar sobre ela. Para propor uma alteração nos arquivos, abra um pull request no mesmo repositório.

Organização no GitHub · Repositório do protocolo — acesso por convite · Repositório do site — acesso por convite · Livros e artigos no GitHub — acesso por convite · Contato

Relate vulnerabilidades pelo canal privado de segurança.

Ler esta página em Markdown