VRaptor

Como contribuir com o VRaptor

Participando das listas de discussão

Você pode responder às dúvidas dos outros usuários no GUJ Respostas, no Stackoverflow ou na nossa lista de discussão para usuários no Google Groups.

Colaborando com documentação

Você pode ajudar escrevendo Javadocs, melhorando o conteúdo do site, com alguma receita em nosso Cookbook ou com algum artigo em seu blog. A documentação do VRaptor está no subprojeto vraptor-site no Github. Mais informações aqui.

Reportando bugs e sugerindo novas funcionalidades

Se você encontrou um bug, avise a equipe de desenvolvimento do VRaptor usando a lista de discussão para usuários. Se você quer sugerir o desenvolvimento de uma funcionalidade use a lista para desenvolvedores. Você também pode cadastrar uma issue no Github.

Colaborando com código

Se você tem alguma melhoria que gostaria de ver no VRaptor, envie sua sugestão para os desenvolvedores na lista de discussão. Se você já implementou a melhoria, envie seu pull request pelo Github.

Você pode resolver umas das issues cadastradas no Github, enviando-nos um pull request com as suas alterações.

O VRaptor é um Framework Web MVC focado em simplicidade e facilidade de uso. Quando você implementar algo, cuide para seguir as boas práticas de Orientação a Objetos e baixo acoplamento, uso de composição ao invés de herança, convenção ao invés de configurações e um código bem estruturado. Não deixe, também, de escrever os Javadocs e classes de testes unitários.

Contribuições de funcionalidades como segurança, paginação, multitenant, e outros são muito bem vindos por meio de plugins e contribuições para o vraptor-contrib.

Montando o ambiente

O primeiro passo para começar a contribuir com código no VRaptor é fazer um fork do projeto. Acesse nosso projeto no Github e faça um fork do projeto. Um fork, em poucas palavras, é uma cópia que você faz do nosso projeto. Assim você pode fazer todas as alterações que você quiser em seu fork, e quando quiser enviar essas alterações para nós, basta fazer um pull request.

Um pull request é uma ação que envia para nós as suas alterações. Assim nós podemos avaliar sua contribuição e dar algumas sugestões. Assim que sua contribuição estiver completa, nós podemos fazer um merge para assim estar disponível na próxima versão do VRaptor.

Todos os módulos do VRaptor usam o Apache Maven, que possui suporte nas principais IDEs. Depois que você fizer o clone do seu fork, basta importá-lo na sua IDE preferida como um Maven project.

Uma boa prática que sugerimos é deixar o branch master sempre atualizado com o código oficial do vraptor, e criar suas modificações sempre em um branch novo criado a partir do master. Desta forma quando você enviar um pull request para nós, você estará enviando sempre o código mais atualizado possível.