Ways to Contribute

General

• Help Write Documention
• Submit Bugs or Feature Requests
• Create a New Project
• Help Moderate the Forums and Mailing Lists
• Tweet about this project

Code

• Submit a Patch

General

Help Write Documentation

One of the most important aspects reflecting the quality of an open source project is the availability of high quality documentation.  There are two broad classes of documentation:

• Online notes: contribute to the Wiki on this web site (register for account)
• Documentation in the distribution: contribute as a code contribution described below

Submit Bugs or Feature Requests

Like good documentation, code quality is an essential ingredient for success.   The Core team is dedicated to making sure high priority bugs are fixed, and we need your help to get an accurate account of oustanding issues.  We also welcome feature requests filed in the same tracking system.

If you run across an issue with the software release or documentation, or this site, do the following:

• Check with the ccnx-users mailing list to see if other people have experienced a similar problem.  Sometimes the issue is related to configuration or involves messages or symptoms that are hard to interpret.  A quick check with the community can help get you past such problems faster, or at least help you to figure out whether the issue is with documentation, diagnostics, or real implementation bugs. 
• Don't be shy about filing issues in the project Bugtracker (regardless of which kind they are)!  We do ask that you  perform a quick search of the database first, to see if the issue has already been filed.  This can be tricky, and we recognize that the same bug can manifest in different ways or may be described differently by different people.  When in doubt, go ahead and file the bug.
• Your help with a bug can range from reporting, to evaluation, to suggesting a workaround or fix, to creating a fix (a code contribution)
• Please see the Guide to Issue Tracking for more information.

Create a New Project

As you start to learn about CCNx, you will find that we've only scratched the surface on what can be done.  In order to leverage the expertise of the community, we offer this site as a great place to start your CCNx project, to organize your project team, socialize the project, and get support from the community.  Creating a project is simple.  From the navigation menu, select Create Content->Project Group.  Once you've created a project, you can add members to the project, configure the project settings, and start adding new Project Pages.  Feel free to upload your important project documents, and share these with the project members as well.  Of course, if you need to keep aspects of your project private, you can do this.  For hosting any source code, we strongly recommend GitHub, BitBucket, or Google Code (if you must use Subversion). 

Help Moderate the Mailing Lists

Another way you can get involved is to help others.  A successful Open Source community needs a strong group of domain experts who can help fill in the resource gaps by answering questions and sharing wisdom about the project.  While the Core Team will do this as well, it can be a huge way to help provide rapid response to user and developer related questions.  As this is a community, we'd ask you review the CCNx Community Principles.  Ultimately, mailing lists provide the first level of support for an Open Source project after the docs or the code has failed.  Sure, users don't always have a handle key concepts, or haven't read the docs, but we'd like encourage questions with thoughtful answers.   No flames or throwing the manual at users.  Also, works for me doesn't work as an answer.  Usually there is a deeper issue,  usually with the environment, but if we can identify new bugs, we'd like to drill down into every problem we find so we can improve the project. 

Tweet About This Project

One way to support the CCNx project is to help spread the word.  Have something interesting to say about CCNx?  Having problems with the latest build?  Want to tell people about something interesting you are doing with CCNx?  Tweet it.  When doing so, use the #ccnx hash tag with your tweets.  This helps contextual search and increases the visibility of your posts.

Come across an interesting tweet about Project CCNx?  Re-tweet it.

Code

We encourage contributions to the source code (including documentation in the code tree).  In order to make contributions you must first sign and return the Contributor Agreement to assure that contributed code may be redistributed consistent with the open source licenses used in Project CCNx.  In addition, we request that all contributors:

• Join ccnx-dev mailing list
• Get involved in the technical discussion as appropriate and initiate discussion about new work before investing a lot of effort.
• Update the bug database with information related to what they are working on or have discovered.
  • You may volunteer to work on a bug by writing to ccnx-dev mentioning the bug id.  After discussion and confirmation the project managers may assign the bug to you.

Making Code Contributions

Project CCNx uses git for managing the source code. You can submit a patch created with git format-patch for consideration by the Core Development team. (Instructions coming)