Adicionando seu documento ao módulo de manuais

Pedindo direitos de envio
O que se pode ou não fazer assim que você tem direito de envio
Enviando seu trabalho

Quando seu documento é finalizado, e você o verificou que o mesmo é gerado corretamente, você deseja que o mesmo seja adicionado ao módulo de manuais. Se esta é a primeira contribuição ao projeto de documentação, você deve ter concordado com os coordenadores que você os enviará para eles para revisão, ou colocar no ar a versão html num website de modo que a mesma possa ser discutida na lista. Depois disso - e após algumas correções feitas - seu documento será adicionado ao módulo. Se você já possui direito de envio você pode fazer isso você mesmo; se não possui, um dos coordenadores fará isso por você.

Pedindo direitos de envio

Para receber direitos de envio primeiro você precisa de uma conta de usuário no SourceForge. Se não uma, registre-se em http://sourceforge.net/account/register.php . Então poste uma mensagem na lista firebird-docs com o seu nome no SF e pedindo para ser adicionado ao projeto Firebird. O líder subprojeto de manuais e de vários outros projetos lêem a lista; eles irão considerar sua requisição. Como regra geral você deve perguntar sobre direitos de envio após sua primeira contribuição, porque as pessoas que decidem sua precisam de algo para se basearem.

As seguintes frases atualmente significam a mesma coisa, a propósito:

Se tornar um membro do projeto
Ter direitos de envio
Ter acesso de leitura e escrita ao repositório.

O que se pode ou não fazer assim que você tem direito de envio

Assim que você for aceito como membro do projeto, você terá acesso a todo o repositório Firebird, não apenas ao módulo de manuais. Não existe nenhuma barreira técnica que o impeça de enviar mudanças aos outros módulos - o módulo núcleo firebird2 por exemplo, ou mesmo CVSROOT onde importantes informações do projeto são guardadas.

Você já deve ter adivinhado que isso NÃO é a idéia. Siga as seguintes regras:

Nunca envie nada aos outros módulos a não ser que as pesoas responsáveis peçam isso explicitamente.
Apenas envio trabalho para o módulo de manuais se isso é uma tarefa designada para você. E mesmo assim, é de bom tom que você anuncie suas mudanças e adições para lista de discussão, de modo que outros documentadores tenham uma chance de comentá-las. Afinal, isto é um esforço coletivo.
Se você pensa que um novo documento ou pasta deve ser adicionado, não crie e envie direto, mas proponha isso na lista.

Na prática, as coisas são um pouco mais leves que o dito acima, especialmente onde isso se refere às suas tarefas. Nós não queremos que você se sinta preso e tendo a sensação de que tem de pedir permissão para cada coisinha que tiver de mudar. Mas nós queremos que você aja responsavelmente, e também que saibamos o que cada um está fazendo. Além disso, mantendo-se em contato com os outros é inspirativo. Junto nós podemos fazer isso funcionar!

Enviando seu trabalho

Mesmo que você seja um membro do projeto, você pode apenas enviar mudanças de uma cópia local se o checkout for feito com o seu login no SF (SourceForge). Se você ainda está trabalhando com uma cópia a qual você fez check out anonimamente você primeiro deve fazer um SSH check out, e então reaplicar suas mudanças e enviá-las. Reveja o Howto Gerando as manuais Firebird se você não lembra com fazer um SSH checkout.

Se algum tiver passado do seu último checkout ou atualização, então faça uma atualização antes de enviar. Isto fará que sua cópia local esteja em sincronismo com o repositório e reduzirá a possibilidade de conflitos.

Assim que você esteja pronto para enviar, vá para a pasta manual. Se você usa um CVS em linha de comando, digite:

cvs update -d [ apenas se você deseja fazer uma atualização antes ]

cvs commit -m "Alguma mensagem informativa aqui"

Depois do -m, e dentro de aspas, voce digita uma mensagem curto sobre este envio, algo como "Adicionadas algumas funções para a referência da API" ou "Erros no tutorial do isql corrigidos".

Dê a sua senha do SF quando perguntado, e todas as mudanças que você fez - incluindo nas subpastas - serão enviadas. Seu cliente CVS sabe qual servidor deve contatar; esta e outras informações são armazenadas nos subdiretórios CVS que foram criados no checkout.

Se você usa outro cliente CVS, reveja sua (do programa) documentação.