Hide last authors
Vincent Massol 21.1 1 We're always looking for contributions! Here are some ways to participate in XWiki's development:
2
Manuel Smeria 21.6 3 {{toc numbered="true"/}}
krokosjablik 10.1 4
krokosjablik 12.1 5 = Give us your Feedback =
VincentMassol 1.1 6
Ecaterina Moraru (Valica) 36.1 7 Do you have a great idea? Just tell us! Send your feedback to the user or developer [[mailing lists>>MailingLists]] or in the [[XWiki Survey>>xwiki:Survey.ProductFeedback]]. The feedback could be also about something that does not work, something that could be improved, a feature you'd like to see, etc. Or simply it could be that you're a happy user. Letting us know that helps a lot!
Vincent Massol 7.2 8
Vincent Massol 32.1 9 You could also check the [[feedback we've already received>>xwiki:Main.Feedback]]. If you like XWiki, Writing a nice quote about it would be really nice too. See [[examples>>xwiki:References.Testimonials]]. You could also tweet it using the ###xwiki## hashtag.
10
Vincent Massol 29.1 11 = Report an issue =
12
Thomas Mortagne 35.1 13 You can report issues to the [[XWiki issue tracker>>https://jira.xwiki.org]] (you'll need to register an account there the first time). The issue tracker project to report in is usually the [[Platform project>>https://jira.xwiki.org/browse/XWIKI]].
Vincent Massol 29.1 14
15 == Reporting a security issue ==
16
17 There are 2 options:
Ecaterina Moraru (Valica) 36.1 18
Thomas Mortagne 35.1 19 * Create an issue in the [[Platform project>>https://jira.xwiki.org/browse/XWIKI]] and make sure to select "Confidential" in the "Security Level" field so that the issue is made private and cannot be accessed by anyone evil who would use the knowledge to hack into XWiki instances.
Vincent Massol 29.1 20 * Send a mail on the [[Security Mailing List>>dev:Community.MailingLists#HPrivateMailingLists]] if you prefer to discuss the problem instead of registering an issue (for example if you're not sure it's a real problem). Note that reporting an issue will also send a notification mail to the Committers of the project and they'll be able to reply to you too.
21
Vincent Massol 30.1 22 In general we recommend using the issue tracker since this allows the Committers to have a registered issue which they know they won't be able to forget! :)
23
krokosjablik 12.1 24 = Help other users =
25
slauriere 43.2 26 Have you gained some experience with XWiki? How about sharing your experience with others? Answer questions on the [[user forum>>Discuss]] or on [[IRC>>Community.IRC]].
krokosjablik 12.1 27
28 == Strategies for answering questions ==
29
krokosjablik 11.1 30 Here's a good strategy that improves the XWiki documentation on xwiki.org:
Vincent Massol 3.1 31
slauriere 43.2 32 1. someone (A) asks a question (on a xwiki list, forum or IRC)
Vincent Massol 3.1 33 1. someone (B) knows the answer
34 1. B verifies that the answer can be found on xwiki.org and if so gives a link to it in the reply to A
Vincent Massol 17.2 35 1. If the answer is not found on xwiki.org, then B adds it {{{(*)}}} and in his reply to A he provides a link to the answer (see the [[Documentation>>#HDocumentation]] chapter below for some tips)
Vincent Massol 3.1 36
krokosjablik 12.1 37 In this manner we all enrich the XWiki documentation and it'll only take marginally longer to answer questions. The next time someone asks the question again we can simply point him/her to the location on xwiki.org
38
39 What happens otherwise is that people will give very long and elaborate answers with lots of knowledge/wisdom in them. After that another person comes in, asks the same question and we answer again, etc. The results are:
40
Vincent Massol 3.1 41 * the xwiki.org documentation is not better
42 * overall as a team we are less efficient
43
JoshuaRieken 14.2 44 = Spread the word =
45
Eduard Moraru 24.2 46 Do you like XWiki? Spread the word about it! In any way you would prefer, like Tweets, Articles, Blogs, Books, Talks at conferences, Discussion with colleagues, etc.
krokosjablik 9.1 47
Patrick Masson 23.1 48 = Join the Community =
Patrick Masson 22.1 49
Patrick Masson 23.1 50 Want to find others to discuss/promote XWiki use? Add yourself to the [[XWiki Users, Groups & Staff map>>https://maps.google.com/maps/ms?msid=210331808187331529022.0004f02bd076d94db85c6&msa=0]].
51
krokosjablik 12.1 52 = Testing =
krokosjablik 9.1 53
Thomas Mortagne 35.1 54 * Test new XWiki versions and report bugs in [[JIRA>>https://jira.xwiki.org]]. It's important to [[correctly report bugs>>http://www.chiark.greenend.org.uk/~~sgtatham/bugs.html]].
Vincent Massol 21.1 55 * Report Compatibility of extensions with XWiki versions. Go to the [[extension you have tested>>extensions:Main.WebHome]], edit the extension page and fill the Compatibility field.
VincentMassol 1.5 56
krokosjablik 12.1 57 = Translations =
VincentMassol 1.5 58
krokosjablik 12.1 59 Is XWiki not available in your native language? Are current translations not good enough or just not complete? By contributing to the [[Translation Wiki>>http://l10n.xwiki.org]] you can improve that.
Vincent Massol 7.1 60
Thomas Mortagne 35.1 61 You could also help by fixing an [[open translation-related issue>>https://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+XINFRA+AND+component+in+%28%22l10n.xwiki.org%22%29+AND+status+%3D+Open+ORDER+BY+priority+DESC]].
Vincent Massol 23.3 62
krokosjablik 12.1 63 = Documentation =
VincentMassol 1.5 64
Vincent Massol 19.1 65 Not satisfied with the XWiki documentation? You have 2 options:
Manuel Smeria 21.6 66
Thomas Mortagne 35.1 67 * Report what you think should be improved by [[creating a JIRA issue for it>>https://jira.xwiki.org/browse/XINFRA]]
Vincent Massol 45.1 68 * Look at the [[Documentation>>xwiki:Documentation.WebHome]] and help us improve it. One difficulty is to find the right location for new documentation. So here are a few tips:
Vincent Massol 32.3 69 ** Add code snippets to the [[Snippets wiki>>snippets:Main.WebHome]]
Vincent Massol 19.1 70 ** Add explanations on how to use XWiki to the related [[Features guide pages>>platform:Features.WebHome]]
71 ** Add development explanations to the related [[Developer guide's pages>>platform:DevGuide.WebHome]]
72 ** Add configuration and administration explanations to the related [[Administration guide's pages>>platform:AdminGuide.WebHome]]
73 ** Add other explanations to the [[FAQ>>xwiki:FAQ.WebHome]]
VincentMassol 1.1 74
Vincent Massol 45.1 75 And if you wish to write a new documentation page or new tutorial, feel free to do that in the [[Drafts area>>Drafts.WebHome]] and ping the devs on the [[forum>>https://forum.xwiki.org]] on using the [[chat>>Community.Chat]] when it's ready or if you have questions, and we can talk together about where to move it in the doc proper.
76
Thomas Mortagne 35.1 77 Not sure what to work on? Check out the [[pending documentation todos>>https://jira.xwiki.org/browse/XINFRA-80?jql=project%20%3D%20XINFRA%20AND%20component%20in%20(%22xwiki.org%22)%20AND%20status%20%3D%20Open%20ORDER%20BY%20priority%20DESC]], pick an issue and start contributing. Feel free to [[create your own todo as well>>https://jira.xwiki.org/browse/XINFRA]].
Silvia Macovei 17.1 78
Vincent Massol 21.1 79 = Contribute Code =
krokosjablik 11.1 80
Vincent Massol 43.1 81 To help you contribute code we've prepared some **[[onboarding instructions>>Onboarding.WebHome]]**.
VincentMassol 1.1 82
Vincent Massol 43.1 83 More generally there are various ways to contribute code:
84
Manuel Smeria 21.6 85 * If you've developed some XWiki Extensions (applications, macros, even some code snippets in the form of scripts) you can share them easily with others by publishing them on [[the extensions wiki>>extensions:Main.WebHome]].
Vincent Massol 21.1 86 * If you're also interested in sharing the source code we encourage you to publish the code as an [[XWiki Contrib Project>>contrib:Main.WebHome]]. This allows others to work collaboratively with you on this code and improve it and fix bugs.
87 * If you've fixed bugs or added new features/improvements to existing extensions or modules check the [[next section>>#existingcode]].
Manuel Smeria 21.6 88 * [[Become part of the XWiki Development Team>>Committership]]!
Vincent Massol 21.1 89
90 {{id name="existingcode"/}}
Patrick Masson 23.1 91
Vincent Massol 12.2 92 = Fixing bugs or new Features/Improvements =
LuisArias 1.7 93
Manuel Smeria 21.6 94 Have you fixed a boring bug or added a new feature or improved an existing one? Let us know by [[adding a pull request>>https://help.github.com/articles/creating-a-pull-request]] to our [[GitHub repository>>dev:Community.SourceRepository]].
Denis Gervalle 18.1 95
Thomas Mortagne 35.1 96 Are you looking for a place to start? Look at our [[open issues in our Issue Tracker>>https://jira.xwiki.org]]. You can also check the [[Paper Cuts>>Main.PaperCut]] which lists some easy to fix issues.
VincentMassol 1.1 97
Vincent Massol 21.1 98 == Code acceptance criteria ==
VincentMassol 1.1 99
Vincent Massol 21.1 100 There are a number of criteria that your code will be judged on:
Jean-Vincent Drean 2.1 101
VincentMassol 1.1 102 * Whether it works and does what is intended. This one is probably obvious!
Vincent Massol 21.1 103 * Whether it fits with the spirit of the project. Some code may be rejected as they take the project in a different direction from that which the current development community has chosen. This is usually discussed on an issue well before the code is contributed. So if you are unsure about submitting some code please discuss it there or on the mailing lists first. Feel free to continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.
104 * Whether it contains tests. It is expected that code relating to functionality will be accompanied by unit tests and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage. As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.
VincentMassol 1.1 105 * Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community we are striving to increase the current coverage of documentation.
106
Manuel Smeria 21.6 107 Above all, don't be discouraged. These are the same requirements the current [[Committers>>Committership]] should hold each other to as well.
108 And remember: your contributions are always welcome !
VincentMassol 1.1 109
krokosjablik 11.1 110 == Coding rules ==
VincentMassol 1.1 111
Vincent Massol 21.1 112 If you submit code you need to follow these rules:
krokosjablik 11.1 113
krokosjablik 12.1 114 * Put the correct [[Copyright>>xwiki:Main.License#HCopyright]] in the files.
Manuel Smeria 21.6 115 * Ensure that your code passes the [[build>>Building]]. {{info}}The build contains some Checkstyle checks that your code must pass.{{/info}}
Vincent Massol 48.1 116 * Ensure that you have [[unit tests and/or integration tests>>dev:Community.Testing.WebHome]].
VincentMassol 1.1 117 * Use the same code formatting as the existing code.
Vincent Massol 46.1 118 * Create an issue in [[JIRA>>https://jira.xwiki.org]] or assign yourself to an existing JIRA issue and add a link to the [[GitHub Pull Request>>https://help.github.com/articles/creating-a-pull-request]]. {{info}}Please make sure you tag the JIRA issue with the **patch** keyword for better handling by the committers.{{/info}}
krokosjablik 12.1 119 * Create [[documentation>>#HDocumentation]] for what you have added.
VincentMassol 1.1 120
Vincent Massol 33.1 121 More generally you can find details in the development documentation:
Ecaterina Moraru (Valica) 36.1 122
Vincent Massol 33.1 123 * [[Development Practices>>Community.DevelopmentPractices]]
124 * [[Code Style>>Community.CodeStyle]]
125
Vincent Massol 21.1 126 In addition if you plan to contribute large amount of code that impact existing code, we recommend discussing it on the mailing list first.
Thomas Mortagne 24.1 127
Ecaterina Moraru (Valica) 37.1 128 = Contribute Designs =
129
130 There are various ways to contribute design related artefacts:
131
132 * You can propose new ideas/features/improvements in the [[Design>>design:Main.WebHome]] wiki
133 * You can provide resources (graphics, fonts, icons) on our [[Media Resources>>dev:Community.Contributing]] page
134
135 You can get feedback on the proposals on the mailing lists or on the Forum.
136
Eduard Moraru 27.1 137 = Sponsoring issues =
138
Vincent Massol 47.2 139 If there are [[issues>>https://jira.xwiki.org]] you'd like to see fixed, you can vote them up and wait for some good soul to come along and fix them. The other option you have to try and speed up this process is to sponsor an issue. You can do that by contacting [[one of the companies supporting the development of XWiki>>xwiki:Main.Supporters.SponsoringCompanies.WebHome]] and sponsor them to develop the feature you need or to get [[Professional Support>>xwiki:Main.Support#HProfessionalSupport]].
Vincent Massol 28.1 140
Vincent Massol 44.1 141 {{info}}
142 At some point in the past, we were using a JIRA plugin for [[FreedomSponsors.org>>http://www.FreedomSponsors.org]] (check out their [[FAQ>>https://freedomsponsors.org/faq]] for more information on how it works). You could click on the "Sponsor This!" link on the issue itself (see screenshot below). We're using [[FreedomSponsors.org>>http://www.FreedomSponsors.org]] and you should.
Eduard Moraru 28.4 143
Vincent Massol 44.1 144 We've stopped using that since the JIRA plugin wasn't supported anymore when we upgraded the xwiki.org JIRA instance.
Eduard Moraru 28.3 145
Vincent Massol 44.1 146 {{image reference="sponsorIssue.png" width="800"/}}
147 {{/info}}
148
Thomas Mortagne 24.1 149 = Improve contribution process =
150
151 See [[Contributions pain points>>ContributingPainPoints]].
Vincent Massol 38.1 152
153 = Google Summer of Code =
154
Vincent Massol 39.1 155 See [[GoogleSummerOfCode.WebHome]].
Vincent Massol 38.1 156
157 = Google Code-In =
158
Vincent Massol 39.1 159 See [[GoogleCodeIn.WebHome]].

Get Connected