This is a guide on how to contribute to the Discourse open-source project in various ways including advocacy, design, documentation, translation, code contributions, bug reporting, and financial support.
Required user level: Anyone can contribute!
Many passionate people often ask how they can give back to Discourse. The simple answer is, “You’re awesome! ” and yes, there are many ways you can contribute.
Summary
In this documentation, we’ll cover:
- Different ways you can give back to Discourse
- Step-by-step guides on how to get involved
- Best practices for each form of contribution
- Solutions to common issues you may run into
- Frequently asked questions about contributing
Everyone is welcome
Discourse is an open-source project. Contrary to popular belief, contributing to an open-source project isn’t limited to coding. There are several other important areas where you can make a difference.
Advocacy
One of the best ways to support Discourse is by advocating for it. Talk about Discourse whenever you can, without being pushy.
Common Advocacy Methods
- Meta’s Praise Category: Share your positive experiences with Discourse in the praise category. Also, consider reviewing Discourse on these 3rd party sites.
- X (formerly Twitter): Use @discourse to share your community stories. We read all your posts.
- Other social media: We may not have official accounts on other social platforms, but they’re still a great place to tell people about Discourse.
- Meetups: Join or organize meetups through platforms like meetup.com. Discuss Discourse by connecting with people interested in topics like Ruby, JavaScript, and Open Source.
Design
You can contribute to design by participating in ongoing ux or feature discussions. You can also create a theme or theme-component.
- Check designs like Material Design or components like Header Categories Navbar.
- Follow guides like Beginner’s Guide to Using Discourse Themes and Developer’s Guide to Discourse Themes.
Documentation
If you’re at trust level 2 or above, you can help by updating or creating documentation.
- Verify and update existing documentation in Documentation and how-to articles.
- Create new how-to guides by and following our guide on writing them.
- Try to follow the documentation style guide as far as possible
Documentation Categories
- Using Discourse
- Site Management
- Integrations
- Hosted Customers
- Self-Hosting
- Migrating to Discourse
- Developer Guides
- Contributing
Translation
If you speak multiple languages, contribute by translating Discourse.
- Follow the translation contribution guide.
- Join the conversation in translations.
Code
If you’re familiar with Rails and Ember.js or want to learn them, you can contribute code.
- Start with a theme-component or plugin.
- Refer to guides like Beginner’s Guide to Using Theme Creator and Creating Discourse Plugins.
- Follow the development and contribution guidelines.
Bug Reports
If you encounter bugs, you can help by reporting them.
- Ensure the bug is reproducible.
- Follow the bug report guide.
Money
If you or your organization has more financial resources than time, consider subscribing to our premium hosting service. We do not take donations, but paying for our hosted service goes directly to the same core team that develops Discourse.
Frequently Asked Questions
How do I know where to start?
With so many options, it can be daunting. Here’s some advice:
- Read all the things: Start with the Top page to stay updated with major events.
- Do the things you think people should be doing: If you think the community could benefit from something, go ahead and do it.
Can contributors get paid?
Yes, some contributions are paid either by the Discourse company or third parties. We encourage paid contributions but understand it’s not always possible. Regardless of how it happens, contributions should ideally be driven by intrinsic motivation and a desire to grow the Discourse project and community.
Additional Resources
- Writing effective how-to documentation
- Contributing translations to Discourse
- Contributing to Discourse development
Last edited by @hugh 2024-06-12T21:28:04Z
Last checked by @hugh 2024-06-11T02:08:22Z
Check document
Perform check on document: