Wiki source code of Onboarding

Last modified by Simon Urli on 2020/01/03 13:54

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = Welcome =
6
7 Welcome to the XWiki community! We're very happy to see you here :)
8
9 This page will help you getting started as a member of the XWiki Community and start contributing to the project.
10
11 It's organized in the form of Tasks that you should perform to get familiar with the various tools and practices.
12
13 Since there are various domains where you could contribute, we've organized them in Tracks.
14
15 = Become part of the community =
16
17 First things first, let's actually join the community communication channels.
18
19 The XWiki community uses various tools to **communicate**:
20
21 1. Register on https://www.xwiki.org (//Hint: click the Drawer icon in the top right corner of the screen//)
22 1. Register on https://forum.xwiki.org using your XWiki.org account (//see [[Community.Discuss]] for more details//) and introduce yourself by creating a post in https://forum.xwiki.org/c/Other
23 1. Register on https://riot.im/app/, access the ###xwiki## chat room and say hello (//see [[Community.Chat]] for more details//)
24
25 If you are interested in the **development** part of our community, you should also:
26
27 1. Create an account on our [[issue tracker>>https://jira.xwiki.org]], in order to report and fix issues.
28 1. Have a [[GitHub>>https://github.com]] account, if you want to make a [[pull request>>https://help.github.com/articles/creating-a-pull-request]] to our [[source repositories>>dev:Community.SourceRepository]].
29 1. Subscribe to our development [[mailinglists>>Community.Discuss||anchor="HMailingLists"]].
30
31 = Getting to know XWiki =
32
33 * Track 1: [[Understand XWiki concepts of XClass & XObjects>>TrackXObjects]]
34 * Track 2: [[Extend your application>>TrackMacro]]
35 * Track 3: [[Styling XWiki>>TrackStyling]]
36
37 = Start contributing =
38
39 * Track 4: [[Report or find an issue>>TrackIssues]]
40 * Track 5: [[Contribute to the core>>TrackCore]]
41
42 Future tracks to document:
43
44 * Track: Interactivity in XWiki (JSX, WebJars, Special CSS classes, Front-end Resources)
45 * Track: Contribute to an existing extension
46 * Track: Contribute a new extension
47 * Track: Add translations
48
49 Other resources:
50
51 * [[Getting started with XWiki for extension developers>>doc:Drafts.GettingStartedWithXWiki]]. Note: We need to merge this document into those onboarding pages.
52
53 {{comment}}
54 [[Translations Tutorial>>doc:Drafts.TranslationsTutorial]]
55
56 IDEA: reuse info from [[http:~~/~~/dev.xwiki.org/xwiki/bin/view/Drafts/GettingStartedWithXWiki>>doc:Drafts.GettingStartedWithXWiki]] or do something with it
57
58 = Report issues =
59
60 Register in https://jira.xwiki.org (//see [[Community.Contributing||anchor="HReportanissue"]] for more details//).
61
62 = Contribute translations =
63
64 Register on http://l10n.xwiki.org.
65
66 = Contribute code =
67
68 == Contribute an extension ==
69
70 Writing or contributing to an extension is generally the best way to to get used to XWiki APIs and architecture.
71
72 === Fix bugs ===
73
74 === Introduce new features ===
75
76 When thinking about introducing a new feature or a big changes it's important to explain what you plan to do (even if your are not 100% sure yet) in an entry of http://design.xwiki.org and to talk about it on the devs mailing list. That way you will get advices on how to improve your proposal or warning if you are not going in the right direction.
77 {{/comment}}

Get Connected