Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Mojolicious::Guides::CUseriContributed PerMojolicious::Guides::Contributing(3)

NAME
       Mojolicious::Guides::Contributing - Contributing	to Mojolicious

OVERVIEW
       There are many ways to contribute to Mojolicious, this guide will show
       you a few of them.

REPORTING BUGS
       We use the GitHub issue tracker
       <https://github.com/mojolicious/mojo/issues>,  so you'll	need to	create
       a (free)	GitHub account to be able to submit issues, comments and pull
       requests.

       First of	all, make sure you are using the latest	version	of
       Mojolicious, it is quite	likely that your bug has already been fixed.
       If that doesn't help, take a look at the	list of	currently open issues,
       perhaps it has already been reported by someone else and	you can	just
       add a comment confirming	it.

       If it hasn't been reported yet, try to prepare a	test case
       demonstrating the bug, you are not expected to fix it yourself, but
       you'll have to make sure	the developers can replicate your problem.
       Sending in your whole application generally does	more harm than good,
       the "t" directory of this distribution has many good examples for how
       to do it	right. Writing a test is usually the hardest part of fixing a
       bug, so the better your test case the faster it can be fixed. ;)

       And don't forget	to add a descriptive title and text, when you create a
       new issue. If your issue	does not contain enough	information or is
       unintelligible, it might	get closed pretty quickly. But don't be
       disheartened, if	there's	new activity it	will get reopened just as
       quickly.

   Reporting security issues
       Please report security issues directly to Sebastian Riedel
       ("kraih@mojolicious.org"), and give us a	few days to develop and
       release a proper	fix.

RESOLVING ISSUES
       There are many ways in which you	can help us resolve existing issues on
       the GitHub issue	tracker	<https://github.com/mojolicious/mojo/issues>.

       Can you replicate the problem on	your computer? Add a comment saying
       that you're seeing the same. Perhaps you	can provide additional
       information that	will make it easier for	others to replicate the
       problem,	maybe even contribute a	better test case.

       And for all code	contributions we very much appreciate additional
       testing and code	review,	just add a comment to show your	approval or to
       point out flaws that need to be addressed.

CONTRIBUTING DOCUMENTATION
       One of the easiest ways to contribute to	Mojolicious is through
       documentation improvements. While the Mojolicious::Guides are carefully
       curated by the core team, everybody with	a (free) GitHub	account	can
       make changes and	add new	information to the Mojolicious wiki
       <https://github.com/mojolicious/mojo/wiki>.

       Pull requests with additions or changes to the documentation included
       in the Mojolicious distribution follow the same rules as	code
       contributions. Please don't send	pull requests for overly simplistic
       changes,	such as	the addition of	a comma	or semicolon.

CONTRIBUTING CODE
       All code	contributions should be	sent as	GitHub pull requests
       <https://help.github.com/articles/using-pull-requests>.	But please try
       to avoid	pull requests with very	simplistic changes, such as a single
       typo fix	somewhere in the documentation or comments.

       An expressive title and detailed	description are	invaluable during the
       review process, which usually ends when members of the community	have
       voiced their opinions and the core team reviewed	the changes. For a
       pull request to get merged it requires three positive reviews from
       voting members of the core team.

       All code	changes	should emulate the style of the	surrounding code,
       include tests that fail without them, and update	relevant
       documentation.

       While the Mojolicious distribution covers a wide	range of features, we
       are rather conservative when it comes to	adding new ones. So if your
       contribution is not a simple bug	fix, it	is strongly recommended	that
       you discuss it in advance in the	Forum <https://forum.mojolicious.org>
       or the official IRC channel "#mojo" on "irc.freenode.net" (chat now!
       <https://webchat.freenode.net/#mojo>), to avoid unnecessary work	and to
       increase	its chances of getting accepted.

       The following mission statement and rules are the foundation of all
       Mojo and	Mojolicious development. Please	make sure that your
       contribution aligns well	with them before sending a pull	request.

   Mission statement
       Mojo is a web development toolkit, with all the basic tools and helpers
       needed to write simple web applications and higher level	web
       frameworks, such	as Mojolicious.

       All components should be	reusable in other projects, and	in a UNIXish
       way only	loosely	coupled.

       Especially for people new to Perl it should be as easy as possible to
       install Mojolicious and get started. Writing web	applications can be
       one of the most fun ways	to learn a language!

       For developers of other web frameworks, it should be possible to	reuse
       all the infrastructure and just consider	the higher levels of the
       Mojolicious distribution	an example application.

   Rules
       General rules for the project:

	 Web development should	be easy	and fun, this is what we optimize for.

	 The web is a moving target, to	stay relevant we have to stay in
	 motion	too.

	 Keep it simple, no magic unless absolutely necessary.

	 The installation process should be as fast and	painless as possible.
	 (Less than a minute on	most common hardware is	a good rule of thumb)

	 It's not a feature without a test and documentation.

	 A feature is only needed when the majority of the user	base benefits
	 from it.

	 Features may only be changed in a major release, to fix a serious
	 security issue, or after being	deprecated for at least	3 months.

	 Refactoring and deprecations should be	avoided	if there are no
	 substantial benefits.

	 New features can be marked as experimental to be excluded from
	 deprecation policies.

	 A major release is signaled by	a new major version number and a
	 unique	code name based	on a Unicode character.

	 Only add dependencies if absolutely necessary and make	them optional
	 if possible.

	 Emulate the style of the existing code	and documentation, but don't
	 be afraid to adopt newer best practices if you	can apply them
	 consistently.

	 Domain	specific languages should be avoided in	favor of Perl-ish
	 solutions.

	 Documentation belongs to the guides, module POD is just an API
	 reference.

	 The main focus	of the included	documentation should be	on examples,
	 no walls of text. (An example for every one or	two sentences is a
	 good rule of thumb)

	 Everything should be ordered alphabetically if	possible, or at	least
	 be consistent if not.

	 The master source code	repository should always be kept in a stable
	 state,	use feature branches for actual	development.

	 Code has to be	run through Perl::Tidy with the	included .perltidyrc
	 <https://github.com/mojolicious/mojo/blob/master/.perltidyrc>,	and
	 everything should look	like it	was written by a single	person.

	 Functions and methods should be as short as possible, no spaghetti
	 code.

	 Comments should be correctly capitalized, and funny if	possible,
	 punctuation is	optional if it doesn't increase	readability.

	 No names outside of "Mojolicious.pm".

   Voting Rules
       The voting process used to make decisions for the project:

	 A feature can be added	or modified when at least 3 members of the
	 core team have	cast a vote in favour, or the BDFL overruled the vote.

	 Any core team member may nominate new members,	who must then be
	 accepted by a 2/3 majority vote.

	 Sebastian has veto rights on all decisions and	will resolve issues
	 that could not	be decided with	a vote.

CODE OF	CONDUCT
       Like the	technical community as a whole,	the Mojolicious	team and
       community is made up of a mixture of professionals and volunteers from
       all over	the world, working on every aspect of the mission - including
       mentorship, teaching, and connecting people.

       Diversity is one	of our huge strengths, but it can also lead to
       communication issues and	unhappiness. To	that end, we have a few	ground
       rules that we ask people	to adhere to. This code	applies	equally	to
       founders, mentors and those seeking help	and guidance.

       This isn't an exhaustive	list of	things that you	can't do. Rather, take
       it in the spirit	in which itas intended - a guide to make it easier to
       enrich all of us	and the	technical communities in which we participate.

       This code of conduct applies to all spaces managed by the Mojolicious
       project.	This includes IRC, the mailing lists, the issue	tracker, and
       any other forums	created	by the project team which the community	uses
       for communication. In addition, violations of this code outside these
       spaces may affect a person's ability to participate within them.

       If you believe someone is violating the code of conduct,	we ask that
       you report it by	emailing Joel Berger ("jberger@mojolicious.org") or
       other members of	the team.

       o Be friendly and patient.

       o Be welcoming. We strive to be a community that	welcomes and supports
	 people	of all backgrounds and identities. This	includes, but is not
	 limited to members of any race, ethnicity, culture, national origin,
	 colour, immigration status, social and	economic class,	educational
	 level,	sex, sexual orientation, gender	identity and expression, age,
	 size, family status, political	belief,	religion, and mental and
	 physical ability.

       o Be considerate. Your work will	be used	by other people, and you in
	 turn will depend on the work of others.  Any decision you take	will
	 affect	users and colleagues, and you should take those	consequences
	 into account when making decisions. Remember that we're a world-wide
	 community, so you might not be	communicating in someone else's
	 primary language.

       o Be respectful.	Not all	of us will agree all the time, but
	 disagreement is no excuse for poor behavior and poor manners. We
	 might all experience some frustration now and then, but we cannot
	 allow that frustration	to turn	into a personal	attack.	Itas important
	 to remember that a community where people feel	uncomfortable or
	 threatened is not a productive	one. Members of	the Mojolicious
	 community should be respectful	when dealing with other	members	as
	 well as with people outside the Mojolicious community.

       o Be careful in the words that you choose. We are a community of
	 professionals,	and we conduct ourselves professionally. Be kind to
	 others. Do not	insult or put down other participants. Harassment and
	 other exclusionary behavior aren't acceptable.	This includes, but is
	 not limited to:

	 o Violent threats or language directed	against	another	person.

	 o Discriminatory jokes	and language.

	 o Posting sexually explicit or	violent	material.

	 o Posting (or threatening to post) other people's personally
	   identifying information ("doxing").

	 o Personal insults, especially	those using racist or sexist terms.

	 o Unwelcome sexual attention.

	 o Advocating for, or encouraging, any of the above behavior.

	 o Repeated harassment of others. In general, if someone asks you to
	   stop, then stop.

       o When we disagree, try to understand why. Disagreements, both social
	 and technical,	happen all the time and	Mojolicious is no exception.
	 It is important that we resolve disagreements and differing views
	 constructively.  Remember that	weare different. The strength of
	 Mojolicious comes from	its varied community, people from a wide range
	 of backgrounds. Different people have different perspectives on
	 issues. Being unable to understand why	someone	holds a	viewpoint
	 doesnat mean that theyare wrong. Donat	forget that it is human	to err
	 and blaming each other	doesnat	get us anywhere. Instead, focus	on
	 helping to resolve issues and learning	from mistakes.

FORK POLICY
       The Mojolicious core team believes that there is	a lot of value in the
       entire toolkit being a unified project. Forks drain resources from a
       project,	not just mindshare but also very valuable bug reports and
       patches,	which can have very serious security implications. Therefore
       we ask that you please not publically fork pieces of the	Mojolicious
       distribution without our	consent. As doing so is	against	our express
       wishes, individuals who engage in unauthorized forking may be denied
       from participating in community sponsored spaces.

       For developers considering the use of a forked module, we strongly
       recommend that you make yourself	familiar with its history and track
       record. While many parts	of Mojolicious have been forked	in the past,
       very few	forks have been	able to	keep up	with Mojolicious development,
       and most	are missing critical bug fixes.

MORE
       You can continue	with Mojolicious::Guides now or	take a look at the
       Mojolicious wiki	<https://github.com/mojolicious/mojo/wiki>, which
       contains	a lot more documentation and examples by many different
       authors.

SUPPORT
       If you have any questions the documentation might not yet answer, don't
       hesitate	to ask in the Forum <https://forum.mojolicious.org> or the
       official	IRC channel "#mojo" on "irc.freenode.net" (chat	now!
       <https://webchat.freenode.net/#mojo>).

perl v5.32.1			  2020-12-Mojolicious::Guides::Contributing(3)

NAME | OVERVIEW | REPORTING BUGS | RESOLVING ISSUES | CONTRIBUTING DOCUMENTATION | CONTRIBUTING CODE | CODE OF CONDUCT | FORK POLICY | MORE | SUPPORT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Mojolicious::Guides::Contributing&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help