| 1 |
--- |
| 2 |
# Copyright (C) 2009-2011 the original author or authors. |
| 3 |
# See the notice.md file distributed with this work for additional |
| 4 |
# information regarding copyright ownership. |
| 5 |
# |
| 6 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 |
# you may not use this file except in compliance with the License. |
| 8 |
# You may obtain a copy of the License at |
| 9 |
# |
| 10 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 11 |
# |
| 12 |
# Unless required by applicable law or agreed to in writing, software |
| 13 |
# distributed under the License is distributed on an "AS IS" BASIS, |
| 14 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 |
# See the License for the specific language governing permissions and |
| 16 |
# limitations under the License. |
| 17 |
|
| 18 |
title: Contributing |
| 19 |
in_menu: false |
| 20 |
--- name:overview |
| 21 |
|
| 22 |
# How to contribute to ${project_name} |
| 23 |
We love contributions! |
| 24 |
|
| 25 |
--- name:content |
| 26 |
|
| 27 |
We really want you to get involved in the ${project_name} project, to |
| 28 |
[join the community](index.html) and help make it a better price of |
| 29 |
software - please do dive in and help! |
| 30 |
|
| 31 |
Try surf the [documentation](../documentation/index.html) and website in |
| 32 |
general - if something is confusing or not clear, [let us |
| 33 |
know](index.html) or raise a [support request](support.html). |
| 34 |
|
| 35 |
[Download](../download.html) the code and try it out and see what you think. |
| 36 |
Browse the [source code](source.html). Got an itch to scratch, want to |
| 37 |
tune some operation or add some feature? |
| 38 |
|
| 39 |
Want to do some hacking on the ${project_name} code? Try surfing the our |
| 40 |
[Issue Tracker]("${project_issue_url}") for open issues or features that |
| 41 |
need to be implemented, take ownership of an issue and try fix it. |
| 42 |
|
| 43 |
## Improving the documentation |
| 44 |
|
| 45 |
Documentation is massively important to help users make the most of |
| 46 |
${project_name} and its probably the area that needs the most help! |
| 47 |
|
| 48 |
So if you are interested in helping the documentation effort; whether its |
| 49 |
just to fix a page here or there, correct a link or even write a tutorial |
| 50 |
or improve what documentation is already there please do dive in and |
| 51 |
help\! |
| 52 |
|
| 53 |
All of the documentation is stored in project source repository, see [How |
| 54 |
the Site works](site.html) |
| 55 |
|
| 56 |
## If you find a bug or problem |
| 57 |
|
| 58 |
Please raise a new issue in our [Issue Tracker](${project_issue_url}). If |
| 59 |
you can create a JUnit test case then your issue is more likely to be |
| 60 |
resolved quicker. Then we can add your issue to our [source control |
| 61 |
system](source.html) and then we'll know when its really fixed and we can |
| 62 |
ensure that the problem stays fixed in future releases. |
| 63 |
|
| 64 |
## Working on the code and creating patches |
| 65 |
|
| 66 |
We gladly accept patches if you can find ways to improve, tune or fix |
| 67 |
${project_name} in some way. |
| 68 |
|
| 69 |
${include("/community/_creating_patches.ssp.md")} |
| 70 |
|
| 71 |
## Becoming a committer |
| 72 |
|
| 73 |
Once you have made some good contributions you may be invited to become a |
| 74 |
committer by the project team. We'll chat to you offline about it. |