Development/FAQs/General FAQ

From KDE TechBase
Revision as of 21:23, 1 May 2012 by Vitorboschi (talk | contribs) (Created page with "Caso faça backup de sua chave privada SSH, garanta que os backups também estão armazenados de maneira segura.")


Desenvolvimento/FAQs/FAQ geral


Eu quero começar uma nova aplicação. O que você recomenda?

Todos concordamos que existem muitas aplicações para o KDE que precisam ser escritas. Mas também há muitas aplicações existentes no KDE que necessitam sua ajuda.

Para ver as áreas que precisam ajuda, veja esta página.

Antes de começar uma nova aplicação, é uma boa idéia verificar o KDE-Apps.org em busca de projetos existentes e também perguntar na lista de emails kde-devel se alguém já está trabalhando em algo similar.

Sou um desenvolvedor, como posso contribuir com o KDE?

KOffice e KDevelop, apesar de muito aclamados, possuem muito poucos desenvolvedores, então você pode verificar lá. Não é necessário ser um dos principais desevolvedores do KDE para ajudar. O KDE é muito modular, sendo possível melhorar uma área sem conhecer como o sistema completo funciona.

Você também pode perguntar na lista kde-devel por alguém precisando ajuda com algum aplicativo. Utilize a última versão do KDE e repare nas coisas necessárias. Um gerador de temas? Um editor de schema para o Konsole? Melhorar um jogo? Sempre há um pequeno recurso faltando. Vá e implemente-o!

Você é familiar ou sente-se atraído por alguma área específica? Verifique se alguma aplicação relacionada pode ser melhorada. Ou escreva uma nova. O KDE precisa de mais aplicações orientadas a não-geeks.

Eu não sou desenvolvedor, como posso ajudar?

Existem inúmeras tarefas que não exigem habilidades em programação. Escreva reviews de aplicativos para promover o KDE (veja a lista kde-promo), ajude o time de documentação (veja i18n.kde.org/doc), ajude os tradutores (veja i18n.kde.org), ajude a filtrar os bugs reportados (veja bugs.kde.org).

Onde encontro imagens de Konqi, o dragão?

The Konqi for some people SDK is at ftp.kde.org/pub/kde/devel/konqi_sdk.tar.bz2
It was posted to artist.kde.org before that site ceased to be updated.

Mais imagens estão disponíveis em KDE merchandise.

Qual é o nível exigido para contribuir com o KDE? O que devo aprender? O que devo ler?

Você deve conhecer C++. Leia os tutoriais do Qt e navegue por sua documentação para familiarizar-se com os recursos disponibilizados. Depois, leia os tutoriais do KDE e navegue por sua arquitetura e documentação. Ler o KDE Book também não machuca. No entanto, não é necessário conhecer toda a sua arquitetura para tornar-se um desenvolvedor KDE. É muito fácil utilizar nossas tecnologias, portanto concentre-se no que você realmente precisa, e o resto você vai aprendendo com o tempo. KDE TechBase e doc.qt.nokia.com (também disponível no seu $QTDIR/doc/html) são recursos inestimáveis, use-os. Por fim, navegue pelo código-fonte, olhe os diretórios com exemplos, veja como os outros codificam suas aplicações. Ler e escrever código é a melhor maneira de aprender.

Como obter o código do KDE dos repositórios git ou SVN?

Veja a seção "Compilando e Executando o KDE a partir do fonte" na página Primeiros passos

Posso acessar o fonte do KDE online?

Sim

O que devo colocar dentro do meu .subversion/config?

[miscellany]
global-ignores = *.moc *.moc.cc *.moc.cpp config.log config.status \
config.cache *.gmo .deps .libs SunWS_cache *.lo *.la *.rpo *.la.closure \
*_la_closure.cpp *_la_closure.cc *_la_closure.cxx *.all_cc.cc *.all_cpp.cpp \
*.all_C.C *.all_cxx.cxx *_meta_unload.cc *_meta_unload.h *_meta_unload.cpp \
*_meta_unload.C *_meta_unload.cxx index.cache.bz2 .memdump Makefile.rules.in \
Makefile.calls.in Makefile.rules Makefile.calls autom4te.cache *.kidl \
*.o *.lo *.la #*# .*.rej *.rej *.pyc

E para fazer o svn diff ignorar espaços em branco, e imprimir os nomes das funções:

[helpers]
diff-cmd = /usr/local/bin/_svndiff

com o seguinte em /usr/local/bin/_svndiff:

#!/bin/sh
exec /usr/bin/diff -b -u -p "$@"

Não se esqueça de tornar /usr/local/bin/_svndiff executável.

Eu quero colocar meu aplicativo no KDE

Existem três requisitos:

  • seu aplicativo deve compilar com a última versão do KDE (git master ou SVN trunk).
  • seu aplicativo deve ser estável.
  • seu aplicativo deve ser mantido. Você provavelmente receberá uma boa quantidade de relatos de problemas e outros pedidos, e as pessoas esperam que você conserte os problemas e implemente os pedidos que façam sentido.

Veja também a próxima questão.

É melhor desenvolver dentro ou fora do KDE?

As core developer Waldo Bastian explains in a copyrighted mail:

Being part of KDE means that you have to work together with others. Such cooperation brings along advantages but it also brings along responsibilities.

Algumas das vantagens são: seu código irá para todas as distros, outras pessoas podem arrumar seus problemas, você ganha traduções e documentação, e também toneladas de relatos de bugs.

Por outro lado, existem algumas desvantagens e responsabilidades: você terá que comunicar-se com outros desenvolvedores sobre seu trabalho, outras pessoas podem modificar seu código, você deverá respeitar os congelamentos pré-lançamento, você receberá toneladas de relatos de problemas, e as pessoas esperam que você arrume-os também (o que elas andam fumando?), elas esperam que você mantenha o código.

Você não pode escolher as vantagens e ignorar as responsabilidades que vêm com elas, é um pacote fechado. É tudo ou nada.

Em geral é o autor de um software quem decide colocar sua aplicação nos repositórios do KDE. Nós normalmente não colocamos nada no repositório, a menos que o autor assim decida. No outro sentido, se o autor prefere trabalhar sua aplicação em outro lugar, isso também é um direito seu. A menos que haja uma divisão entre o grupo de pessoas trabalhando na aplicação, não faz sentido dividir o desenvolvimento por esse motivo.

MAS... ao colocar seu código sob uma licença de código livre e no repositório do KDE, você dará ao mundo, assim como ao KDE em particular, o direito irrevogável de usar o seu código. E o KDE vai usar desse direito como for conveniente para proteger os interesses do KDE, mesmo que isso possa ir contra os desejos do próprio autor em algum momento.

É importante saber tudo isso, mas não se assuste. Normalmente as coisas funcionam muito bem. Em 5 anos, houve somente uma ocorrência de um desenvolvedor que colocou seu trabalho no KDE e depois quis tirá-lo.

Como obtenho permissão de escrita nos repositórios do KDE?

Leia o artigo completo em Contribua > Obtenha uma Conta de Colaborador KDE.

Vá para [KDE Identity] , preencha o formulário e descreva porque você precisa acesso de escrita. Tenha certeza de fornecer seu nome completo e endereço de email.

Por favor inclua também o nome da sua conta no bugs.kde.org. Caso não exista crie uma para que ela possa receber as permissões de desenvolvedor. Fechar relatos no bugs.kde.org com palavras-chave nos comentários do commit só funciona se o endereço de email no KDE Identity e na conta do bugs.kde.org baterem. Você pode atualizar o endereço no bugs.kde.org nas configurações de usuário do Bugzilla.

O Git requer o uso de uma chave ssh, e novas contas no SVN devem escolher o protocolo svn+ssh. Envia sua chave pública (ex. ~/.ssh/id_dsa.pub) Veja também #How do I create a SSH key?

Caso esteja contribuindo com uma aplicação que não seja sua, é uma boa idéia submeter suas alterações como patches para o autor, e deixar que ele aplique-as. Se o autor não estiver mais mantendo a aplicação, você poderá tornar-se o novo mantenedor...

Apesar de existirem poucas restrições nos direitos de commit no repositório, esperamos que você não modifique o código de outros desenvolvedores sem seu consentimento. Além disso, você deve respeitar os congelamentos previstos na agenda de lançamentos (publicada em developer.kde.org)

Uma lista detalhada com as regras a serem seguidas quando efetivando commit's nos repositórios do KDE está disponível em Política de commit's do KDE.

Meu aplicativo não é estável, mas eu gostaria de tê-lo no KDE

Inicialmente podemos coloca-la no playground, que basicamente é um "kde-alpha". Desenvolva-a lá e quanto estiver pronta, requisite que sua aplicação seja movida para o pacote apropriado do KDE, ou para o módulo extragear.

Eu não quero perder o meu histórico do SVN.

Isso não é mais possível com o Subversion. Talvez no futuro, se o servidor for atualizado e permitir isso. Note que isso não é problema no caso do git.

O que é kdebindings?

It contains Qt bindings for Ruby, PHP, C# to use Qt classes with those langages, KDE bindings for Ruby, C#, python to use KDE classes with those langages, and XParts to embed non-KDE apps as a KPart. Check the binding page of TechBase.

O congelamento funcionalidades aplica-se ao playground?

Não, o playground não libera pacotes. O mesmo é válido para o kde-review e extragear: eles não são congelados e liberados. Mas se você quer mover seu aplicativo para algum pacote, peça-o antes da liberação da versão beta.

Posso ter uma versão estável e outra instável do KDE no mesmo computador?

Sim, leia a documentação sobre Compilação de 2 versões.

Como saber qual versão do Qt/KDE eu estou utilizando?

kde-config e todos os programas do KDE aceitam --version como argumento.

Qt-copy ou Qt do qt.nokia.com : se alguém vai fazer uma compilação do trunk partindo do zero, qual é preferível?

Você pode usar qualquer uma. Elas são bináriamente compatíveis (para frente ou para trás). Pode haver, no entanto, algumas pequenas correções no qt-copy em relação à versão mais recente do Qt. Caso esteja compilando do qt-copy, dê atenção especiao ao script apply-patches.

Como posso baixar um único diretório de um módulo SVN?

Baixe o diretório principal com o comando 'svn co -N /nomedomodulo', 'cd nomedomodulo', 'svn up admin' para obter o diretório admin, para então baixar o diretório desejado com 'svn up subdir'

Por exemplo, para obter somente o reaktivate do playground/utils: svn co -N /playground/utils; svn up reaktivate E então compile normalmente.

A mesma resposta se aplica para a questão "Como obtenho somente um idioma do kde-i18n?".

Se não souber o nome do diretório que quer baixar, você pode navegar o websvn.kde.org para encontra-lo.

Como posso baixar uma aplicação KDE como um tarball independente?

O kdesdk/scripts/svn2dist é um script que extrai uma aplicação do código fonte do KDE e empacota-o como uma aplicação independente.

Como fecho meus relatos de problemas (bug reports)?

Se você reportou um problema que foi corrigido em uma nova versão do KDE mas continua marcado como aberto, você pode fechá-lo. Isso pode acontecer quando o seu problema é o mesmo que algum outro, ou simplesmente porque o desenvolvedor corrigiu alguma coisa sem perceber que isso corrigiria também o seu problema.

Você pode fazê-so diretamente no seu commit. Para isso, adicione à mensagem de commit uma linha como essa:

BUG: XXXXX onde XXXXX é o número do problema que você quer fechar. Se o relato sendo fechado é relacionado à adição de uma nova funcionalidade, você pode utilizar FEATURE ao invés de BUG.

Gerenciar uma lista de bugs é uma tarefa enorme para os desenvolvedores e elas normalmente possuem uma grande quantidade de entradas, algumas delas já corrigidas sem que eles saibam, outras não-reproduzíveis, algumas sem as informações necessárias para que a correção seja feita, etc. Se puder ajudar fazendo o gerenciamento e atualização da lista de problemas pendentes, você será muito bem-vindo. E você receberá boas vindas ainda mais alegres se você fornecer a correção.

Como crio a chave SSH?

O SSH utiliza duas chaves: uma privada e outra pública. Você deve sempre manter a chave privada em segredo e coloca-la apenas em máquinas as quais você tenha controle direto. Máquinas públicas, compartilhadas e comunitárias não são ambientes adequados para armazenar chaves privadas. Tome medidas que evitem o roubo de sua chave privada. Configurar uma senha em sua chave privada é muito bom para evitar os riscos envolvidos no caso de roubo da chave privada.

Gere um par de chaves para cada um dos principais locais de onde você trabalha. Isso ajuda a reduzir o impacto quando sua chave é roubada. Quando alguém obtém acesso à sua chave privada, ela pode ser utilizada abusivamente em tentativas de ataque contra os servidores do KDE. Alguns conhecidos projetos de código livre foram comprometidos desta maneira no passado, portanto VOCÊ deve nos ajudar a garantir que isso não aconteça também com o KDE. Por esse motivo é importante notificar sysadmin (em) kde (ponto) org assim que você perceber que alguém possa ter obtido acesso à sua chave privada. Por exemplo, quando um computador onde ela está armazenada é invadido ou infectado por vírus, worm ou trojan.

Caso faça backup de sua chave privada SSH, garanta que os backups também estão armazenados de maneira segura.

For the practical part, the following command can be used to generate a SSH private/public key pair with ssh-keygen -t dsa This will create a private key as ~/.ssh/id_dsa and a public key as ~/.ssh/id_dsa.pub.

There are times when you may want to use a key of a different name to the default, perhaps to use separate keys for different projects. To let SSH know which key you want to use for KDE.org, you can keep a list of servers and their corresponding keys in ~/.ssh/config. For example,

Host svn.kde.org 
IdentityFile ~/.ssh/id_dsa_kde

In order to use SSH to access KDE servers you need to send your public key to sysadmin (at) kde (dot) org.

How can I monitor changes made by others?

The kde-commits mailinglist carries automatic notifications for all changes made in the KDE repositories. The KDE-Commits mailinglist is very high traffic. An alternative is CommitFilter which allows you to get notification for only those areas that interest you.