Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 3.02 KB
Raw

Contributing to Bananas Screen Sharing

Thanks for checking out Bananas Screen Sharing! 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.

Table of Contents

  1. Types of contributions we're looking for
  2. Ground rules & expectations
  3. How to contribute
  4. Style guide
  5. Documentation
  6. Code
  7. Setting up your environment
  8. Community

Types of contributions we're looking for

There are many ways you can directly contribute to Bananas Screen Sharing:

  • Feature requests
  • Bug reports
  • Code contributions
  • Writing or editing documentation

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.
  • Bananas is 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.
  • When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created, as others will do so if they appreciate it.

How to contribute

If you'd like 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 guide, open a pull request.

Style guide

Documentation

If you're writing documentation, see the style guide (which uses vale) to help your prose match the rest of the documentation.

Code

When writing code, please follow these configurations:

Most of them are automatically checked by the CI, so you don't need to worry about them.

Community

Discussions about the Bananas take place on:

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.