Flarum Community Guidelines

Toby

Welcome to the Flarum Community!

... And thanks for joining us! We're excited about Flarum, and are always happy to meet people who feel the same way. We want everyone to get the most out of Flarum and the Flarum community, so we ask that you please read and follow these guidelines. And enjoy your visit here!

Looking for Support?

You've come to the right place! We're always busy working hard to make Flarum better, so there are limits to the help we can provide. Specifically:

Support is provided to users who want to help test Flarum and report issues responsibly.
Support for extension development is provided primarily to troubleshoot Flarum's extensibility.
24/7 support is not guaranteed. It might take a few hours or a few days until someone with the right knowledge sees your issue and replies.
Post underSupport to get started.

If you qualify, then please feel free to post about your issue. Be sure to provide any information that's requested. And remember: the staff here always have lots of stuff to do, so please be patient!

Make Yourself Heard

Want to start a new discussion? First, be sure to read our FAQ and follow the links to make sure you're fully informed about the project. Then spend some time browsing the forum, familiarize yourself with the tag system, and do a few searches for keywords related to your topic: it could be someone has already started a discussion about it!

When you're sure you're ready to start a discussion, please keep the following points in mind:

Give it a good title! You'll get the best results if your title makes it clear what you want to talk about.
Choose the right tag(s). This will increase the likelihood your post will be read and answered promptly.
Don’t post repeatedly about the same topic, as doing so will tend to have the opposite effect.
If not using a tag set aside for multilingual use, post in English only. We can't help if we can't read you!
Remember, you don't need to sign your posts. We've got your profile to let us know who you are.

Please make the effort to help us keep things organized. Time spent tidying up is time that we can't spend getting to know you, discussing your issues, and talking about Flarum. And that, after all, is what we're all here to do!

Make Your Reply Count

You're taking the time to participate in a discussion, in the hope that others will read your ideas and take them into consideration. So why not make the effort to make your reply worth reading?

Don't reply to a title. Take some time to read the OP, and at least scan the rest of the conversation first.
Ask yourself if your reply adds to the discussion. If it doesn't, give it some more thought before posting.
Avoid making one-word posts just to agree with someone; you can use the "Like" link for that.
Avoid making multiple posts in a row when one would suffice. This is a forum, not a chat room.
If your reply is likely to divert the course of the discussion, consider starting a new discussion instead.
If you just want to post a bit of nonsense as a test, please do it in theTest Posting tag instead.
Make sure your replies provide constructive feedback and support to allow for an inclusive community.

No one's going to complain about the occasional joke or smart remark. We like to keep the mood light! But to keep things productive, as well, we ask that you try to avoid derailing a discussion altogether.

Above All, Be Cool!

We're all here to talk about Flarum, and to work together toward making it an even better application. Criticizing ideas (by means of reasoned arguments, of course) is an important part of that. But let's not get carried away and devolve into personal attacks, because negativity only gets in the way. We also ask that you avoid the following:

Offensive or abusive language, as well as any kind of hate speech
Posts intended to harass, impersonate, or defame others
Unnecessary deletion of posted content
Attempts to abuse or expose the private information of others
Obscene or sexually explicit content
Spam, phishing posts, and any actions intended to deface this site
Obfuscating a link's true destination, for example with the use of link shorteners
Discussion of software piracy and similar topics

All the above are grounds for moderator action. If you have an issue with another member, we ask that you please don't confront them yourself. Please just use the Report command on the post in question, then leave it up to the staff to deal with the situation.

Our moderators may edit or delete any content that is offensive or disruptive to the flow of communication. Serious or repeated offenses may lead to suspension of the offending user's account. So, you know, be cool. 😎

Thanks to @Dominion for his help in putting these guidelines together.

Toby

Welcome Advertisers and Recruiters

We greatly appreciate your support for Flarum, and understand the need to put your voice out there when providing Flarum-related services. To keep this support forum tidy and efficient, so that all our users can find the information they need, we hope you'll stick to the following guidelines concerning advertising.

Flarum-related ads only

In general we allow any Flarum-related advertisements. Examples of suitable content include, but are not limited to:

Ads for Flarum-related services, such as web hosting plans suitable to hosting a Flarum site
Offers to help with Flarum-related tasks such as development, theming, administration, etc.
Job vacancy postings, such as notice of an opening for an admin to run a Flarum community
Help Wanted ads, such as an offer to pay for the development of a custom Flarum extension

Essentially, any post promoting a product, service, or opening is seen as an advertisement; it doesn't matter whether the item being promoted is paid or unpaid, open source or licensed in any form. If the information you want to post fits this description, then it must be related to Flarum in some way.

How and where to post

If you wish to post an advertisement on the site, and you're sure it meets the "Flarum-related" requirement, you are welcome to start one discussion under theResources tag. You may also wish to add any applicable secondary tags that will help users find your advertisement more easily.

RESTRICTIONS

Advertisements not related to Flarum are not welcome. Additionally the following are not appreciated:

Creating multiple threads for the same product, service, or opening
Unsolicited replies with links to your advertisement in other discussions
Using unrelated secondary tags to increase the exposure of your ad
Using affiliate/referer links in posts or profiles
Registering a username intended as an ad (e.g. "my-hosting-company-com"). Only active sponsors are exception to this rule and we reserve the right to withdraw that right at any time.

All the above are subject to moderation without prior notice. If you are unsure whether your advertising content is allowed, or how the above restrictions may apply to it, please contact one of our moderators on Discord.

jordanjay29

Hello Flarum devs!

TheExtensions tag is for you to post your completed extensions.

If you're looking for a place to post in-development/WIP code for testing, see theDev tag.
If you're looking for a place to post extension or feature suggestions, see theFeatures tag.
If you're looking for someone to create an extension for you, please advertise in theServices tag.
If you've got an extension you want to make available to other Flarum admins, you're in the right place!

There are a few simple guidelines we want you to be aware of before posting here, and to keep in mind while your extension lives here. If you follow them, you'll make life that much easier for the folks who use your extensions.

Release-ready extensions only!

Extensions posted must be release-ready. This means it must be possible to install and be compatible with the latest release as of posting. For language packs, this means all English strings should be translated.

Include all necessary information.

The first post must include an English description of your extension (what it is supposed to do) and installation instructions, as well as links to relevant repositories (Packagist, GitHub, GitLab, etc). Don't forget any screenshots (or GIF/video) if your extension has a GUI!

Don't use this space to advertise.

Links to off-site demos or screenshots are acceptable. Paid extensions are allowed, but promotion must be related to the extension and its developer(s). All other links or content must follow Flarum's Advertising Guidelines.

Keep your release up-to-date.

If, after one month following a release of a new Flarum version, your extension has still not been updated to be compatible, it will be marked asIncompatible. This can be removed when a new update is posted.

... That's all. Happy devving!

luceos

Payments Guidelines

To further improve the sustainability of the Flarum project, the team has implemented a couple of ways for people to donate directly on the official Flarum community at discuss.flarum.org (further Discuss) in return for some benefits.

Users on Discuss can donate through the following ways:

A subscription to gain access to a supporter permission group.
One or more payments to promote the development of an upgrade, feature, bugfix or any other proposal. These are furthermore called bounties.

For each of these we have specific terms that you should be aware of if you consider using them in addition to the generic terms of this agreement. Please do read these completely.

1. Shared terms

Parties in these terms are:
1. The recipient of the donation, the Flarum Foundation, registered at the Dutch chamber of commerce as Stichting Flarum under registration number 75601745.
2. The donor, is the person who donates money to the recipient with one or more single or recurring payments.
3. The bounty hunter, is the person who picks up a task with an open bounty.
4. The maintainer, is the person who manages a certain code repository.
All amounts paid shall be nonrefundable once paid.

2. Supporter terms

The donor subscribes to a recurring payment plan to receive the badge "Supporter".
The donor can cancel the subscription through their profile subscriptions page. Cancellations come into effect at the end of the current period.
The donor shall receive a honorary badge on discuss for as long as the subscription remains active.

3. Bounties terms

The donor can make payments to place a bounty on the completion of a certain task related to Flarum and receive the badge "Devotee".
25 % of all payments related to bounties are reserved by Flarum to allocate people to the management, confirmation and reviews of tasks from bounties. This cut is also used to cover any payment processing fees.
Bounties have no expiration and will not be refunded. In case a bounty is never paid out, it will be used by Flarum for other activities to the benefit of the project.
Flarum retains the right to close any task that contains bounties without providing a reason.
Flarum retains the right to move bounties between or remove bounties from tasks.
Tasks that are valid for a bounty can be, but are not limited by, the following:
1. Bug fixes on Flarum or existing extensions.
2. Feature development on Flarum or existing extensions.
3. The development of new extensions.
4. Creating educational content, like tutorials or videos, related to Flarum.
Discussions on Discuss are valid for bounties, and are as such seen as tasks, if:
1. They are placed under theProposals tag.
2. They have clear requirements and a technical overview for implementation.
3. They are approved by a Flarum team member.
Once a discussion is open to bounties the original (or first) post cannot be modified, except by Flarum staff.
Tasks with open bounties can be picked up by anyone (further bounty hunter), which causes the task to be reserved. A reservation implies that the bounty hunter is going to complete the task and is binding:
1. When the original author of an extension has abstained to work on the task or failed to respond within 7 days to a mention within the discussion by the bounty hunter or Flarum staff.
2. Once the bounty hunter and Flarum staff have agreed to a sensible deadline.
3. As long as the deadline isn't overdue. A Flarum team member will review progress and unless a new deadline is agreed upon, the reservation and bounty payout is voided.
Flarum staff can decide to reduce the total payout or decide against payout from bounties for a given task if:
1. Not all requirements are met.
2. The code or deliverable is of very bad quality.
3. The deadline wasn't met, and no attempt was made by the bounty hunter to discuss a new deadline.
4. The Proposal was tampered with, this includes requirements, technical overview or replies that were fundamental to the task.
Flarum cannot payout bounties to the bounty hunter if:
1. The bounty hunter offers no payment method that works for Flarum.
2. The identity of the bounty hunter isn't confirmed.
3. Legal or fiscal laws limit payout to the bounty hunter.
A payout of the bounty to the bounty hunter happens if:
1. The task is marked completed by the bounty hunter.
2. All requirements are met and confirmed by a Flarum team member.
3. In case of code:
  1. The code has been made available to the public on either GitHub.com or GitLab.com.
  2. The code has been made available under the MIT license.
  3. A pull request has been opened to the original repository or a new extension has been published on packagist.
  4. The code has been reviewed by a maintainer and/or Flarum team member. Modified based on these reviews and approved of by either a maintainer or Flarum team member who is not also the bounty hunter.
4. Upon completion of all previous steps, an email is sent to bounties@flarum.org from the email address used on Discuss to request a payout of the bounty, this email includes;
  1. The discussion on Discuss.
  2. The bounty hunter's username on Discuss.
  3. The full name and address of bounty hunter.
  4. One of the following payout information:
    1. Bank account information (BIC + IBAN), preferred.
    2. PayPal account.
    3. Preferred currency to be used, if different from the bounty currency.
The transaction for a payout:
1. Excludes any transaction or currency exchange costs.
2. Excludes the 25% Flarum reserved for operational costs, see 3.2.

4. Limit of liability

To the extent permitted by law, we are not liable to you for any incidental, consequential or punitive damages arising out of these terms, or your use or attempted use of Discuss, Stripe or any deliverables from tasks with bounties. To the extent permitted by law, our liability for damages is limited to the amount of money we have earned through your use of Discuss. We are specifically not liable for loss associated with failure to deliver tasks and from losses caused by conflicting contractual agreements.