Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 2.92 KB

Contributing to Flashy

Thank you for choosing to contribute to our project! We appreciate your input and want to make contributing to this project as simple and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Check out the README file for an overview of the project.

Any contributions you make will be under the Apache License 2.0

When you submit code changes, they are subject to the same Apache License as the project. If you have any concerns, please contact the project maintainers.

How to Contribute Code

These are the steps you should take to contribute to this project:

  • Create an issue on the Github repository to discuss the proposed change.
  • Fork the repository and contribute to the forked repo in a new branch yourfeature
  • Send a pull request to the origin development branch be reviewed.

Use Android Studio to edit the source.

Following a successful PR review, the project maintainer will merge your contribution into the project.

Releases are based on the trunk branch. A maintainer will create a tagged release and attach a signed .apk. The .apk will go to Google Play too then. F-Droid checks this repository and will start a build when one of their build servers is available.

Hooray! You have successfully contributed to Flashy!

How to Contribute Translations

The translation is managed by Weblate which is accessible under https://hosted.weblate.org/engage/flashy/.
We have two components:

  • Flashy for the app itself
  • Metadata for the store description (F-Droid & Google Play) and changelogs
  • Glossary is not used yet

Hooray! You have successfully contributed to Flashy!

How to Open a Bug Report or Feature Request

We use GitHub issues for the management of issues, bugs and features. You may open an issue by following https://github.com/Crazy-Marvin/Flashy/issues/new/choose.

Hooray! You have successfully contributed to Flashy!

How to Report a Security Vulnerability

Please send me an e-mail to marvin@poopjournal.rocks. I may give you information how to community encrypted. More details may be found in the SECURITY.md

Hooray! You have successfully contributed to Flashy!

How to Contribute Money

Please send an e-mail to marvin@poopjournal.rocks to discuss the details. You may find some options on this page too.

Hooray! You have successfully contributed to Flashy!