Contributing

First off, thanks for your interest in contributing to Flashback! ❤️ Community is what makes open-source successful and you are most welcome to join our project. There are many ways to contribute such as:

  • Reporting feedback. If you are just exploring the app, we'd love to hear your toughts about what's working and what can be improved.
  • Suggesting features. We're always happy to discuss ideas and explore new directions for the project.
  • Contributing code. If you'd like to help us implement features and fix bugs, we welcome all code contributions.
  • Improving documentation. These smaller contributions make the end-user experience much more polished.

Read on to see the generalized process for contributing!

Communication

If you've found a bug or would like to discuss a new feature, it all starts with reaching out. We're friendly, so please don't hesitate.

Here are some ways you can contact us:

  1. The mailing list
  2. The bug tracker

And if you'd like to know more about what's on the horizon, check out our kanban board for details.

Contributing Code

If you would like to contribute code, please reach out through our mailing list or bug tracker to start a discussion. Once you're ready to merge your changes with our main branch, you can send the patch upstream and we will work to get it integrated.

Style Guide

We ask that you please use prettier for formating code files (there is a default profile included in the project) and add tsdocs to every function.