Getting Involved

From Habari Project

Revision as of 00:20, 9 January 2013 by Michaeltwofish (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Habari is a community-driven open source project. Habari is most successful when passionate people share their experience and their expertise to improve it.


Ways to contribute

There are many ways an individual can improve Habari:

  • Help begin to document for both users, and developers
  • Install Habari and test
  • Provide feedback on your experience within your hosting environment
  • Find, reproduce, and document bugs
  • Fix bugs in the source

Our Process


Following the meritocracy model advocated by the Apache Software Foundation, the Habari project rewards contributors with decision making privilege in the project. Regular participants should be able to influence the direction of the project to which they dedicate their time and talent. The requirement for participation will be something of a moving target over time, but the barrier to entry should never be so high that dedicated people are excluded.


A fundamental aspect of successful open source projects is transparency. Decisions are made in the public's eye, and discussion and deliberation takes place in the open. The Habari project pursues transparency by using Github or dev mailing list to maintain a record of proposed changes, and discussion associated with those changes. All proposals -- whether for code, documentation, visual style, etc -- are logged through the issues tracker and mailing list for public scrutiny and input.


All contributions to Habari will acquire the Apache License. For those unfamiliar with this license, the Apache License FAQ page should answer most of your questions.

Developers contributing to the Habari project itself should note that, unless explicitly stated otherwise, any contribution intentionally submitted for inclusion shall be under the terms and conditions of the Apache license, without any additional terms or conditions. However, plugins and themes designed to work with Habari are not required to have the same license as Habari itself.

You can find our license included in the source, and in our code repository.

Where Do I Start?

A good first step is to join the Habari-Dev Google Group. This is where discussion and debate of new proposals will occur.

Next, find something you think you can fix! Whether it's a section of the manual, an incompatibility in a stylesheet, or a glitch in a class method, use the issues tracker to create a new issue. Our code and issues are on Github, which is the central repository for all Habari development activity. Be as specific and as thorough as possible when creating your issue, and submit your code for review. If appropriate, document your server configuration, and if you don't know the specifics, mention which host you are on.

What's Next?

Github will email you any modifications to any issue you create or comment on. Habari developers may ask for additional information, or ask for you to help test proposed fixes, so tracking issues you report is generally a good idea. You can also watch issues you haven't participated in, if you'd like to follow the progress of those issues, too.

As you prepare your changes, ask for review on the development mailing list as often as you need it. Allowing the group to review your proposal could save you the time of implementing something that is being done as part of a larger task, and could gain you the insight or help of other people who are interested in what you're doing. This can be applied to code changes, as well as documentation that will eventually ship with all Habari install packages.

Don't stop now! Keep submitting ideas, patches, and corrections! Comment on other issues in the issues tracker. Share your expertise.

Some Specifics

  • You can move issues that have the next release as the milestone forward by reproducing issues, commenting, writing patches, or writing tests. JibbyBot on IRC can tell you about the next milestone using the ,stats command or you can check on Github.
  • Habari has some unit tests, but many more are needed. The testing process is at least partially documented, and writing tests helps improve our quality processes.
  • Speaking of partially documented, you can help improve the documentation. If you've ever found the documentation to be lacking make a note of it, put up a new page, or add something to an existing page. Don't be afraid to put rough words down, it's a wiki so we can work together to make things better. See the Wiki Structure page to get an idea of how the pages fit together, read the Wiki Style Guide for advice on writing for the wiki, or join the Wiki Working Group.
  • There are also pages that have been marked as Category:Stubs, and some users keep lists of pages they'd like to see written, for example michaeltwofish and mikelietz.
Personal tools