Skip to content

Commit

Permalink
update contributing and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sadespresso committed Jan 30, 2025
1 parent 9e88168 commit c674676
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ As of now, publishing fees have been paid by the maintainer.
NOTE: A quick discussion upfront can highlight any potential issues, streamline
the merge process, and ensure you're on the right track to avoid rework.

TIP: Look for issues with `ready` label to get contributing immediately
TIP: Look for issues with `ready` label to get started without any friction

1. Fork the repository
2. Pick an issue. If the fix/feature you're gonna work doesn't have an issue,
Expand All @@ -39,6 +39,8 @@ implementing a new feature
* Any new dependency must support the all the platforms except for Web
* It is not necessary to change the version unless you're in charge of
publishing a release
* Update [CHANGELOG.md](./CHANGELOG.md) with your change description. (Use
version name `Next`)

## Translating

Expand Down
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ Feedbacks and ideas are greatly appreciated 🌟

Flow in production: [Blog post](https://blog.gege.mn/publishing-flow-to-production-20250104?showSharer=true)

## Support Flow

Flow is a personal project developed during my free time, and it generates no
income. Maintaining Flow on the App Store requires a substantial annual fee
(see [Apple Developer Program](https://developer.apple.com/support/enrollment/#:~:text=The%20Apple%20Developer%20Program%20annual,in%20local%20currency%20where%20available.)),
which [I currently cover](https://github.com/sadespresso). To ensure Flow's
continued existence and future development, your support is greatly appreciated.

[Buy me a coffee](https://buymeacoffee.com/sadespresso)

## Supported platforms

* Android
Expand Down Expand Up @@ -82,3 +92,21 @@ to enhance the UI for desktop experience for now.
[^2]: Please double-check from the official website, may be outdated. Visit
<https://docs.objectbox.io/getting-started#add-objectbox-to-your-project>
(make sure to choose Flutter to see the script).

### Build artifacts

Flow's build logs are freely available for anyone examine.

#### Android

GitHub Actions script is used to build both Fat-APK (multi-architecture), and
appbundles (for Google Play).

* Build scripts: <https://github.com/flow-mn/flow/tree/main/.github/workflows>
* Build logs: <https://github.com/flow-mn/flow/actions>

#### iOS

Due to my skill issues, I couldn't manage to build archives through GitHub
Actions. Currently, [Codemagic](https://codemagic.io) is used to build the
iOS releases.

0 comments on commit c674676

Please sign in to comment.