Skip to content

How to Contribute to ColdDoc

markmandel edited this page Dec 8, 2011 · 1 revision

Thanks for coming to check out how you can help ColdDoc be a fantastic project.

If you want to contribute, but aren't sure of where to apply your unique talents, feel free to ask on the [ColdDoc mailing list]

There are multiple ways in which you can help with this project:

Code Contribution / Developing

If you are interested in contributing code to ColdSpring, be it a bug fix, or a new feature, please don't hesitate.

Please note – code contributions with accompanying unit tests will always be looked on much more favourably than those without.

Source Control

ColdDoc follows the "A successful Git branching model" outlined by Vincent Driessen.

You will find the latest stable releases of ColdDoc in the master branch, and the development version of ColdDoc in the develop branch.

Please issue a pull request for any changes you wish to contribute to the code base.

Documentation

There can always be more documentation for open source projects.

Even if it's just an extra paragraph, a spelling correction or a single line to help clarify a point, it all adds up.

Testing

If you find a bug, please don't keep it to yourself. Report it either to the ColdDoc mailing list or to the issue tracker directly.

Community Support

It's always good to help out your fellow developer, so if you see a question on the ColdDoc mailing list, on twitter, #coldfusion on Dalnet or Freenode IRC or anywhere else for that matter, please feel free to answer and give advice.

Wish Lists / Donations

Last but not least, please feel free to give back to the developers of ColdDoc in a more material fashion, either through wishlists or monetary donations. They are always much appreciated, and are a great way of helping the people who write open source give so much of their time to the ColdFusion community.

Mark Mandel – Author (donation button on the right)