Commit dc7f82f
Changed files (4)
docs/release-process.md
@@ -1,19 +1,21 @@
*developer documentation - users can safely ignore this*
-App release checklist
-- [ ] milestone finished
+## App release checklist
+
- [ ] no remaining breaking issues
- [ ] add translation from [Weblate](https://hosted.weblate.org/projects/blood-pressure-monitor-fl/#repository)
- [ ] in case new languages got added, add them to `iso_lang_names.dart`
- [ ] create changelog
-- [ ] update version in `pubspec.yaml` and `android/app/build.gradle`
+- [ ] update app version name and number in `pubspec.yaml`
+- [ ] update to latest flutter beta and update the flutter version name for f-droid in `pubspec.yaml`
+- [ ] `dart pub upgrade --tighten --major-versions` in health data store dir
+- [ ] `flutter clean` in app dir
+- [ ] `flutter pub upgrade --tighten --major-versions` in app dir
- [ ] verify no tests fail
-- [ ] `flutter clean`
-- [ ] `flutter pub upgrade`
- [ ] compile apk `flutter build apk --release --flavor github --obfuscate --split-debug-info=./build/debug-info`
+- [ ] Manuall release testing: upgrading data and core features
- [ ] compile play-store `flutter build appbundle --release --flavor github --obfuscate --split-debug-info=./build/debug-info`
- [ ] obtain Playstore debug symbols by running `7z a debug-info.zip ./lib/arm64-v8a/ ./lib/armeabi-v7a/ ./lib/x86_64/
` in folder `build/app/intermediates/merged_native_libs/githubRelease/out/`
-- [ ] Google Play beta release
-- [ ] Once a successful update has been reported and the app works, promote the Play release and create a GitHub release
+- [ ] make Play release and create a GitHub release
- [ ] Add debug symbols in `./build/debug-info` to GitHub release
CODE_OF_CONDUCT.md
@@ -0,0 +1,14 @@
+# Code of conduct
+
+As a basis for working together every community member, sponsor, or maintainer has to agree to following these following basic principles in all interaction related to this project or its users.
+
+1. Respect each other as human beings
+2. Don't participate in unrelated discussions like politics or personal differences
+3. Follow all applying laws
+4. Act in the best interest of the apps users
+
+This code of conduct explicitly encourages taking controversial stands on technical topics, as these improve the resulting solutions.
+
+Violating these basic rules, especially if done repeatedly or deliberately, _will_ result in exclusion from discussions and/or contributions.
+
+Anyone can privately raise concerns by sending an email to [contact@derdilla.com](mailto://contact@derdilla.com).
\ No newline at end of file
CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing
+
+This repository has become quite large, so contributions are greatly appreciated and can come in many forms.
+
+<div align="center">
+<img src="https://tokei.rs/b1/github/NobodyForNothing/blood-pressure-monitor-fl?style=flat-square">
+<img src="https://tokei.rs/b1/github/NobodyForNothing/blood-pressure-monitor-fl?category=code&style=flat-square">
+<img src="https://tokei.rs/b1/github/NobodyForNothing/blood-pressure-monitor-fl?category=comments&style=flat-square">
+</div>
+
+*Please note that when contributing you agree that your work is under the same license as the project.*
+
+## Opening bugs and proposing features
+
+This is probably the simplest to do: Use the app and find out what's wrong and what can be improved. There is no such thing as a wrong issue. Just make sure there is no existing one about the exact same topic. If you are unsure about something just create a new issue, the worst thing to happen is that it gets closed.
+
+## Improving texts and translating
+
+Another easy way to help is to go through the texts (this one, store listings or the ones in the app) and fix grammar, punctuation, or other mistakes.
+The easiest way to do this is [weblate](https://hosted.weblate.org/engage/blood-pressure-monitor-fl/).
+
+[](https://hosted.weblate.org/engage/blood-pressure-monitor-fl/)
+
+
+## Coding
+
+Since this is *FOSS*, you can compile the app yourself and adjust it for you own needs and give back those changes so everyone can profit.
+
+We try to keep the code as documented, simple and maintainable as possible, so you won't need to learn the entire codebase. Additional information about data formats and code style suggestions can be found in the [docs](https://github.com/NobodyForNothing/blood-pressure-monitor-fl/tree/main/docs) folder.
+
+To build the app locally you have to:
+1. [set up](https://docs.flutter.dev/get-started/install) flutter
+2. `git clone https://github.com/NobodyForNothing/blood-pressure-monitor-fl.git`
+3. run `dart run build_runner build` in the `health_data_store` directory
+
+After this initial setup you can:
+- Test the app: `flutter run --flavor github`
+- Compile the app `flutter build apk --flavor github --release`
+
+### Pull requests
+
+If you can fix issues or implement features from the issues page feel free to make a PR on GitHub with your changes. While not a strict requirement, it is recommended to talk about it in an issue first.
+
+### Platform-support
+
+I'm looking for people who want to bring this app to many more users on IOS or desktop. If you can test there or can publish apps just email me or open an issue, so we can sort out the details!
+
+## Donations
+
+If you have too much money, I would advise you to donate to either [F-Droid](https://f-droid.org/en/donate/), [Weblate](https://weblate.org/en/donate/), or some other service that has unavoidable maintenance costs.
\ No newline at end of file
README.md
@@ -54,33 +54,4 @@ As there is no demand Windows, Linux and MacOS builds have been stopped. In case
## Contributing
-This repository has become quite large, so contributions are greatly appreciated and can come in many forms.
-
-<div align="center">
-<img src="https://tokei.rs/b1/github/NobodyForNothing/blood-pressure-monitor-fl?style=flat-square">
-<img src="https://tokei.rs/b1/github/NobodyForNothing/blood-pressure-monitor-fl?category=code&style=flat-square">
-<img src="https://tokei.rs/b1/github/NobodyForNothing/blood-pressure-monitor-fl?category=comments&style=flat-square">
-</div>
-
-*Please note that when contributing you agree that your work is under the same license as the project.*
-
-### Opening bugs and proposing features
-
-This is probably the simplest to do: Use the app and find out what's wrong and what can be improved. There is no such thing as a wrong issue. Just make sure there is no existing one about the exact same topic If you are unsure about something just create a new issue, the worst thing to happen is that it gets closed.
-
-### Improving texts and translating
-Another easy way to help is to go through the texts (this one or the ones in the app) and fix grammar/other mistakes or find better (more precise/friendly) ways to put things.
-The easiest way to do this is [weblate](https://hosted.weblate.org/engage/blood-pressure-monitor-fl/).
-
-[](https://hosted.weblate.org/engage/blood-pressure-monitor-fl/)
-
-
-### Pull requests
-If you can code, you can fix issues or implement features from the issues page. While not a strict requirement, it is recommended to talk about it in an issue first.
-
-All parts of the code have extensive documentation and some additional information can be found in the [docs](https://github.com/NobodyForNothing/blood-pressure-monitor-fl/tree/main/docs) folder.
-
-<!--[developer docs](https://bpapp.derdilla.com/)-->
-
-### Donations
-If you have too much money, I would advise you to donate to either [F-Droid](https://f-droid.org/en/donate/), [Weblate](https://weblate.org/en/donate/), or some other service that has unavoidable maintenance costs.
+This app works best when everyone does their part! Anyone interested with a bit of domain knowledge can help make this the best blood pressure app. If you want to provide ideas, translate, code or help in another way *please* check out the [contributor docs](CONTRIBUTING.md).