Skip to content

Commit

Permalink
GH269: how to contribute to vraptor
Browse files Browse the repository at this point in the history
  • Loading branch information
garcia-jj committed Feb 2, 2011
1 parent d5046c7 commit 4366315
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
33 changes: 33 additions & 0 deletions vraptor-site/src/guide/en/20-how-to-contribute.afc
@@ -0,0 +1,33 @@
[chapter How to contribute to VRaptor]

[section Joining the mailing lists]

You can answer questions from other users in our user mailing list (in english) on Google Groups [1].


[section Collaborating with the documentation]

You can help us writing Javadocs, improving site content, with a recipe or an article on your blog.


[section Reporting bugs and suggesting new features]

If you found a bug, tell the development team using the user mailing list [1] or developers mailing list [2]. You can also create an issue on Github [3].


[section Collaborating with code]

If you have any improvements you'd like to see in VRaptor, send your suggestion to the developers mailing list [2]. If you have already implemented, please send your pull request via GitHub.

You can resolve some issue registered on GitHub [3], send us a pull request with your changes.

VRaptor is a MVC Web Framework focused in simplicity and easy of use. When you implement something, take care to follow the best practices of Object Orientation and low coupling, use of composition instead of inheritance, convention over configuration and a well structured code. Make sure you also write the Javadocs classes and unit tests.

Contributions like security, paging, multitenant, and others are welcome through plugins and contributions to vraptor-contrib [4], or extensions to vraptor-scaffold [5].


[1] http://groups.google.com/group/caelum-vraptor-en
[2] http://groups.google.com/group/caelum-vraptor-dev
[3] http://github.com/caelum/vraptor/issues
[4] http://github.com/caelum/vraptor-contrib
[5] https://github.com/caelum/vraptor-scaffold
34 changes: 34 additions & 0 deletions vraptor-site/src/guide/pt/20-how-to-contribute.afc
@@ -0,0 +1,34 @@
[chapter Como contribuir com o VRaptor]

[section Participando das listas de discussão]

Você pode responder às dúvidas dos outros usuários no sub-fórum "Frameworks e Bibliotecas brasileiros" no GUJ [1] ou no Google Groups [2].


[section Colaborando com documentação]

Você pode ajudar escrevendo Javadocs, melhorando o conteúdo do site, com alguma receita ou com algum artigo em seu blog.


[section Reportando bugs e sugerindo novas funcionalidades]

Se você encontrou um bug, avise a equipe de desenvolvimento do VRaptor usando as listas de discussões para usuários [2] ou a lista de desenvolvedores [3]. Você também pode cadastrar uma issue no Github [4].


[section 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 [3]. Se você já implementou a melhoria, envie seu pull request através do Github.

Você pode resolver umas das issues cadastradas no Github [4], 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 através de plugins e contribuições para o vraptor-contrib [5], ou extensões para o vraptor-scaffold [6].


[1] http://guj.com.br/forums/show/23.java
[2] http://groups.google.com/group/caelum-vraptor
[3] http://groups.google.com/group/caelum-vraptor-dev
[4] http://github.com/caelum/vraptor/issues
[5] http://github.com/caelum/vraptor-contrib
[6] https://github.com/caelum/vraptor-scaffold

0 comments on commit 4366315

Please sign in to comment.