1Mojolicious::Guides::CoUnsterribCuotnitnrgi(b3u)ted PerlMoDjoocluimceinotuast:i:oGnuides::Contributing(3)
2
6 Mojolicious::Guides::Contributing - Contributing to Mojolicious
7
9 There are many ways to contribute to Mojolicious, this guide will show
10 you a few of them.
11
13 We use the GitHub issue tracker
14 <https://github.com/mojolicious/mojo/issues>, so you'll need to create
15 a (free) GitHub account to be able to submit issues, comments and pull
16 requests.
17 First of all, make sure you are using the latest version of
19 Mojolicious, it is quite likely that your bug has already been fixed.
20 If that doesn't help, take a look at the list of currently open issues,
21 perhaps it has already been reported by someone else and you can just
22 add a comment confirming it.
23 If it hasn't been reported yet, try to prepare a test case
25 demonstrating the bug, you are not expected to fix it yourself, but
26 you'll have to make sure the developers can replicate your problem.
27 Sending in your whole application generally does more harm than good,
28 the "t" directory of this distribution has many good examples for how
29 to do it right. Writing a test is usually the hardest part of fixing a
30 bug, so the better your test case the faster it can be fixed. ;)
31 And don't forget to add a descriptive title and text, when you create a
33 new issue. If your issue does not contain enough information or is
34 unintelligible, it might get closed pretty quickly. But don't be
35 disheartened, if there's new activity it will get reopened just as
36 quickly.
37 Reporting security issues
39 Please report security issues directly to Sebastian Riedel
40 ("kraih@mojolicious.org"), and give us a few days to develop and
41 release a proper fix.
42
44 There are many ways in which you can help us resolve existing issues on
45 the GitHub issue tracker <https://github.com/mojolicious/mojo/issues>.
46 Can you replicate the problem on your computer? Add a comment saying
48 that you're seeing the same. Perhaps you can provide additional
49 information that will make it easier for others to replicate the
50 problem, maybe even contribute a better test case.
51 And for all code contributions we very much appreciate additional
53 testing and code review, just add a comment to show your approval or to
54 point out flaws that need to be addressed.
55
57 One of the easiest ways to contribute to Mojolicious is through
58 documentation improvements. While the Mojolicious::Guides are carefully
59 curated by the core team, everybody with a (free) GitHub account can
60 make changes and add new information to the Mojolicious wiki
61 <http://github.com/mojolicious/mojo/wiki>.
62 Pull requests with additions or changes to the documentation included
64 in the Mojolicious distribution follow the same rules as code
65 contributions. Please don't send pull requests for overly simplistic
66 changes, such as the addition of a comma or semicolon.
67
69 All code contributions should be sent as GitHub pull requests
70 <https://help.github.com/articles/using-pull-requests>. But please try
71 to avoid pull requests with very simplistic changes, such as a single
72 typo fix somewhere in the documentation or comments.
73 An expressive title and detailed description are invaluable during the
75 review process, which usually ends when members of the community have
76 voiced their opinions and the core team voted for or against a change.
77 To reach the formal voting stage, a member of the core team needs to
78 call for a vote. You are responsible for securing this vote call as
79 well as the required votes. The exact "Voting Rules" can be found
80 below.
81 All code changes should emulate the style of the surrounding code,
83 include tests that fail without them, and update relevant
84 documentation.
85 While the Mojolicious distribution covers a wide range of features, we
87 are rather conservative when it comes to adding new ones. So if your
88 contribution is not a simple bug fix, it is strongly recommended that
89 you discuss it in advance on the mailing list
90 <http://groups.google.com/group/mojolicious> or the official IRC
91 channel "#mojo" on "irc.freenode.net" (chat now!
92 <https://kiwiirc.com/nextclient/#irc://irc.freenode.net/mojo?nick=guest-?>),
93 to avoid unnecessary work and to increase its chances of getting
94 accepted.
95 The following mission statement and rules are the foundation of all
97 Mojo and Mojolicious development. Please make sure that your
98 contribution aligns well with them before sending a pull request.
99 Mission statement
101 Mojo is a web development toolkit, with all the basic tools and helpers
102 needed to write simple web applications and higher level web
103 frameworks, such as Mojolicious.
104 All components should be reusable in other projects, and in a UNIXish
106 way only loosely coupled.
107 Especially for people new to Perl it should be as easy as possible to
109 install Mojolicious and get started. Writing web applications can be
110 one of the most fun ways to learn a language!
111 For developers of other web frameworks, it should be possible to reuse
113 all the infrastructure and just consider the higher levels of the
114 Mojolicious distribution an example application.
115 Rules
117 General rules for the project:
118 Web development should be easy and fun, this is what we optimize for.
120 The web is a moving target, to stay relevant we have to stay in
122 motion too.
123 Keep it simple, no magic unless absolutely necessary.
125 The installation process should be as fast and painless as possible.
127 (Less than a minute on most common hardware is a good rule of thumb)
128 It's not a feature without a test and documentation.
130 A feature is only needed when the majority of the user base benefits
132 from it.
133 Features may only be changed in a major release, to fix a serious
135 security issue, or after being deprecated for at least 3 months.
136 Refactoring and deprecations should be avoided if there are no
138 substantial benefits.
139 New features can be marked as experimental to be excluded from
141 deprecation policies.
142 A major release is signaled by a new major version number and a
144 unique code name based on a Unicode character.
145 Only add dependencies if absolutely necessary and make them optional
147 if possible.
148 Emulate the style of the existing code and documentation, but don't
150 be afraid to adopt newer best practices if you can apply them
151 consistently.
152 Domain specific languages should be avoided in favor of Perl-ish
154 solutions.
155 Documentation belongs to the guides, module POD is just an API
157 reference.
158 The main focus of the included documentation should be on examples,
160 no walls of text. (An example for every one or two sentences is a
161 good rule of thumb)
162 Everything should be ordered alphabetically if possible, or at least
164 be consistent if not.
165 The master source code repository should always be kept in a stable
167 state, use feature branches for actual development.
168 Code has to be run through Perl::Tidy with the included .perltidyrc
170 <https://github.com/mojolicious/mojo/blob/master/.perltidyrc>, and
171 everything should look like it was written by a single person.
172 Functions and methods should be as short as possible, no spaghetti
174 code.
175 Comments should be correctly capitalized, and funny if possible,
177 punctuation is optional if it doesn't increase readability.
178 No names outside of "Mojolicious.pm".
180 Voting Rules
182 The voting process used to make decisions for the project:
183 A feature can be added or modified when at least 3 members of the
185 core team have cast a vote in favour, or the BDFL overruled the vote.
186 Any core team member may nominate new members, who must then be
188 accepted by a 2/3 majority vote.
189 Sebastian has veto rights on all decisions and will resolve issues
191 that could not be decided with a vote.
192
194 Like the technical community as a whole, the Mojolicious team and
195 community is made up of a mixture of professionals and volunteers from
196 all over the world, working on every aspect of the mission - including
197 mentorship, teaching, and connecting people.
198 Diversity is one of our huge strengths, but it can also lead to
200 communication issues and unhappiness. To that end, we have a few ground
201 rules that we ask people to adhere to. This code applies equally to
202 founders, mentors and those seeking help and guidance.
203 This isn't an exhaustive list of things that you can't do. Rather, take
205 it in the spirit in which it’s intended - a guide to make it easier to
206 enrich all of us and the technical communities in which we participate.
207 This code of conduct applies to all spaces managed by the Mojolicious
209 project. This includes IRC, the mailing lists, the issue tracker, and
210 any other forums created by the project team which the community uses
211 for communication. In addition, violations of this code outside these
212 spaces may affect a person's ability to participate within them.
213 If you believe someone is violating the code of conduct, we ask that
215 you report it by emailing Joel Berger ("jberger@mojolicious.org") or
216 other members of the team.
217 · Be friendly and patient.
219 · Be welcoming. We strive to be a community that welcomes and supports
221 people of all backgrounds and identities. This includes, but is not
222 limited to members of any race, ethnicity, culture, national origin,
223 colour, immigration status, social and economic class, educational
224 level, sex, sexual orientation, gender identity and expression, age,
225 size, family status, political belief, religion, and mental and
226 physical ability.
227 · Be considerate. Your work will be used by other people, and you in
229 turn will depend on the work of others. Any decision you take will
230 affect users and colleagues, and you should take those consequences
231 into account when making decisions. Remember that we're a world-wide
232 community, so you might not be communicating in someone else's
233 primary language.
234 · Be respectful. Not all of us will agree all the time, but
236 disagreement is no excuse for poor behavior and poor manners. We
237 might all experience some frustration now and then, but we cannot
238 allow that frustration to turn into a personal attack. It’s important
239 to remember that a community where people feel uncomfortable or
240 threatened is not a productive one. Members of the Mojolicious
241 community should be respectful when dealing with other members as
242 well as with people outside the Mojolicious community.
243 · Be careful in the words that you choose. We are a community of
245 professionals, and we conduct ourselves professionally. Be kind to
246 others. Do not insult or put down other participants. Harassment and
247 other exclusionary behavior aren't acceptable. This includes, but is
248 not limited to:
249 · Violent threats or language directed against another person.
251 · Discriminatory jokes and language.
253 · Posting sexually explicit or violent material.
255 · Posting (or threatening to post) other people's personally
257 identifying information ("doxing").
258 · Personal insults, especially those using racist or sexist terms.
260 · Unwelcome sexual attention.
262 · Advocating for, or encouraging, any of the above behavior.
264 · Repeated harassment of others. In general, if someone asks you to
266 stop, then stop.
267 · When we disagree, try to understand why. Disagreements, both social
269 and technical, happen all the time and Mojolicious is no exception.
270 It is important that we resolve disagreements and differing views
271 constructively. Remember that we’re different. The strength of
272 Mojolicious comes from its varied community, people from a wide range
273 of backgrounds. Different people have different perspectives on
274 issues. Being unable to understand why someone holds a viewpoint
275 doesn’t mean that they’re wrong. Don’t forget that it is human to err
276 and blaming each other doesn’t get us anywhere. Instead, focus on
277 helping to resolve issues and learning from mistakes.
278
280 The Mojolicious core team believes that there is a lot of value in the
281 entire toolkit being a unified project. Forks drain resources from a
282 project, not just mindshare but also very valuable bug reports and
283 patches, which can have very serious security implications. Therefore
284 we ask that you please not publically fork pieces of the Mojolicious
285 distribution without our consent. As doing so is against our express
286 wishes, individuals who engage in unauthorized forking may be denied
287 from participating in community sponsored spaces.
288 For developers considering the use of a forked module, we strongly
290 recommend that you make yourself familiar with its history and track
291 record. While many parts of Mojolicious have been forked in the past,
292 very few forks have been able to keep up with Mojolicious development,
293 and most are missing critical bug fixes.
294
296 You can continue with Mojolicious::Guides now or take a look at the
297 Mojolicious wiki <http://github.com/mojolicious/mojo/wiki>, which
298 contains a lot more documentation and examples by many different
299 authors.
300
302 If you have any questions the documentation might not yet answer, don't
303 hesitate to ask on the mailing list
304 <http://groups.google.com/group/mojolicious> or the official IRC
305 channel "#mojo" on "irc.freenode.net" (chat now!
306 <https://kiwiirc.com/nextclient/#irc://irc.freenode.net/mojo?nick=guest-?>).
307perl v5.30.1 2020-01-3M0ojolicious::Guides::Contributing(3)