Skip to main content

Contributing to Bunkr

caution

This documentation is a work in progress.

Thanks for checking out the Bunkr App! We're excited to hear and learn from you.
We've put together the following guidelines to help you figure out where you can best be helpful.

Types of contributions we're looking for​

There are many ways you can directly contribute to Bunkr (in descending order of need):

Interested in contributing to Bunkr? Read on!

Ground rules & expectations​

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • Open Source Guides are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • Please ensure that your contribution passes all tests if you open a pull request. If there are test failures, you will need to address them before we can merge your contribution.

How to contribute​

Start by searching through the pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this project, open a pull request.

If you're not sure whether your idea fits into the goals of this project, you can open a discussion.

Style guide​

If you're contributing code please make sure it conforms to the style guide.

Setting up your environment​

To get started, fork the Bunkr repository and clone it locally.
For information on how to setup your environment, see the setup guide.

Community​

Discussions about Bunkr take place in its GitHub repository's Issues, Pull Requests and Discussions.
Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.