ter Contributing - Architecture Rules - Wiki

Contributing

From Architecture Rules - Wiki
Jump to: navigation, search


For someone who really wanted to get involved in this projects, there are many ways to do so by following these simple steps:

  1. Pick an item from the list below.
  2. Hop on the User Mailing List, introduce yourself, and tell us what you want to work on.
  3. Complete the selected item, and share the results with us on the mailing list.

Some items are more difficult and require a great time commitment than others, but all contributions are important. Please don't hesitate to mail us and ask questions or propose new ways to contribute.

Join the Community

This one goes for everybody. Join the mailing list and send us your comments. Let us know you use this tool. Tell us how you use it, what you like about it, and what you don't like about it. This is easy to do. Mailing list posts help provide feedback, motivate our developers, spark new discussions, and are a key part to building a bigger community. This is the most important of all the things you can do to help this project grow.

Once your in the mailing list, respond to as many posts as you can. You can help answer questions, or just confirm that a given answer is correct.

Share your experiences. Get on the mailing list and tell us about a situation where Architecture Rules discovered a cycle, or how it detected a violated rule that saved you money, time, or debugging. Please share your success stories.

Code Reviews

Code quality is very important. Code reviews help improve code quality, which increases the maintainability, understandability, and extensibility of the source code. There are a few ways you could review the code.

  1. Browse the source with just your web browser.
  2. Checkout the project and review it in your IDE.
  3. Checkout the project and run code metric generating tools, such as Findbugs. You can report the issues, or even better, fix them.

Documentation

Once potential users find out about Architecture Rules, the documentation is what is going to make or break the conversion of that potential user to a faithful architecture risk mitigating developer. Please help improve the documentation. This is a wiki so its super easy. Just click edit on the top of the page and add your contributions.

  • Help complete the wiki documentation by adding content to the wanted pages.
  • Proof read all pages.
  • Graphics. Graphics help a lot. We could use UML diagrams.

Coding Tasks

Writing code is the most fun way to contribute to the project, but also the most time consuming. Please don't take on any tasks that you don't think you will have time to finish.

  • Pick an open issue. Let us know what you think about it, and how you might implement it on the mailing list.
  • Write new unit tests. We are usually around 80% coverage.
  • Resolve potential bugs from the Findbugs report. You're best off to checkout the project and run mvn site:site to get an up-to-date Findbugs report.

Marketing

Help us find new users, and help potential users find us. Promote Architecture Rules.

  • Write about it in your blog.
  • Give us a copy of your post for our blog.

You could write about

  • The important of mitigating architectural risk and how tools like Architecture Rules can help.
  • How your use Architecture Rules.
  • Issues within your code that Architecture Rules caught.
  • Architecture Rules best practices.
  • Review of java architecture tools to include Architecture Rules.
  • How to develop software using layers that support Separation of concern.
  • Cyclic Dependencies
  • and more.
Retrieved from "http://wiki.architecturerules.org/index.php/Contributing"
Personal tools