Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CrazyMarvin committed Jun 30, 2024
1 parent b947279 commit 979b61c
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,61 @@
# Contributing to Poop Journal

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](https://github.com/Poop-Journal/app/trunk/README.md) 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](https://www.apache.org/licenses/LICENSE-2.0) 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](https://developer.android.com/studio/) or the editor of your choice 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 and .aab. The .aab will go to Google Play too then.

Hooray! You have successfully contributed to Poop Journal!

## How to Contribute Translations

The translation is managed by Weblate which is accessible under [https://hosted.weblate.org/engage/poop-journal/](https://hosted.weblate.org/engage/poop-journal/).
We have two components:
- `Poop Journal` 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 Poop Journal!

## 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/Poop-Journal/app/issues/new/choose](https://github.com/Poop-Journal/app/issues/new/choose).

Hooray! You have successfully contributed to Poop Journal!

## How to Report a Security Vulnerability

Please send me an e-mail to [[email protected]](mailto:[email protected]?subject=Poop%20Journal%20Security%20Vulnerability). I may give you information how to community encrypted. More details may be found in the [`SECURITY.md`](https://github.com/Poop-Journal/app/blob/trunk/.github/SECURITY.md)

Hooray! You have successfully contributed to Poop Journal!

## How to Contribute Money

Please send an e-mail to [[email protected]](mailto:[email protected]?subject=Poop%20Journal%20Donation) to discuss the details.
You may find some options on [this page](https://poopjournal.rocks/blog/donate/) too.

Hooray! You have successfully contributed to Poop Journal!

0 comments on commit 979b61c

Please sign in to comment.