Skip to content

Commit 2e94943

Browse files
Update Project-maintenance.md
1 parent c950086 commit 2e94943

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

android/Project-maintenance.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ This is particularly necessary if the change touches any model classes as ProGua
1414

1515
## Generate release build after verification
1616

17-
1. Add the new features to [CHANGELOG.md](https://github.com/commons-app/apps-android-commons/blob/master/CHANGELOG.md)
18-
1. Increment `versionCode` and `versionName` in [app/build.gradle](https://github.com/commons-app/apps-android-commons/blob/master/app/build.gradle)
17+
1. Add the new features to [CHANGELOG.md](https://github.com/commons-app/apps-android-commons/blob/main/CHANGELOG.md)
18+
1. Increment `versionCode` and `versionName` in [app/build.gradle](https://github.com/commons-app/apps-android-commons/blob/main/app/build.gradle)
1919
1. Commit, and push to Github
20-
1. Tag the commit as `v` + the version number, for instance `v1.32` for version 1.32. This is needed [for F-Droid](https://gitlab.com/fdroid/fdroiddata/blob/master/metadata/fr.free.nrw.commons.txt) (`git tag v1.32`). Don't forget to push the tags (`git push --tags`).
20+
1. Tag the commit as `v` + the version number, for instance `v1.32` for version 1.32. This is needed [for F-Droid](https://gitlab.com/fdroid/fdroiddata/blob/main/metadata/fr.free.nrw.commons.txt) (`git tag v1.32`). Don't forget to push the tags (`git push --tags`).
2121
1. Generate the signed app bundle using the keystore via the **Build > Generate Signed Bundle / APK** menu [[ref](https://developer.android.com/studio/publish/app-signing#sign-apk)]
2222
- Note: In this step, we need to generate an APK not an Android App bundle.
2323
1. Create [a new release](https://github.com/commons-app/apps-android-commons/releases/new) in GitHub and publish the same with appropriate release notes. The CHANGELOG content helps here. Further, GitHub's auto-generated release notes is also helpful as it lists all PRs that were included in this release along with a section highlighting the "New contributors" to that release.
@@ -40,23 +40,23 @@ This is particularly necessary if the change touches any model classes as ProGua
4040

4141
# Branching and hotfix system for releases
4242

43-
- Every major release (e.g. 2.6) should be pulled from master and a new branch created (e.g. `2.6.x-release`)
44-
- Hotfixes to the major release must be done in the `2.6.x-release` branch, not in master
45-
- Hotfix releases (e.g. 2.6.1) will be pulled from the `2.6.x-release` branch. New changes/enhancements to master will not be included in the hotfix release
46-
- Release branches will be merged into master periodically (so master is up to date with hotfixes made to release branches)
43+
- Every major release (e.g. 2.6) should be pulled from main and a new branch created (e.g. `2.6.x-release`)
44+
- Hotfixes to the major release must be done in the `2.6.x-release` branch, not in main
45+
- Hotfix releases (e.g. 2.6.1) will be pulled from the `2.6.x-release` branch. New changes/enhancements to main will not be included in the hotfix release
46+
- Release branches will be merged into main periodically (so main is up to date with hotfixes made to release branches)
4747
- Hotfixes can be released to production after being tested in beta for a few days. Major releases on the other hand should be tested in beta for a much longer time (e.g. 2 weeks?)
4848

4949
# Moderation of the mailing list
5050

51-
The [mailing list](https://groups.google.com/d/forum/commons-app-android) is moderated by volunteers. New users who post to the mailing list have their messages put in a moderation queue, and an email is sent to the moderators asking them to either whitelist or blacklist the person. The moderator receives emails with this kind of title:
51+
The [mailing list](https://groups.google.com/d/forum/commons-app-android) is moderated by volunteers. New users who post to the mailing list have their messages put in a moderation queue, and an email is sent to the moderators asking them to either allowlist or denylist the person. The moderator receives emails with this kind of title:
5252

5353
_commons-app-android - Google Groups: Message Pending [{IJCjjKCbgtX0ASoCb2kwB4ITL8vhkvwd0}]_
5454

55-
A moderator will then review the email, and blacklist or whitelist the sender. All spam will be blacklisted; Spam is often companies that want our app for advertising.
55+
A moderator will then review the email, and denylist or allowlist the sender. All spam will be denylisted; Spam is often companies that want our app for advertising.
5656

5757
Notes for moderators:
5858
- Only mark as spam messages that are clearly spam, or companies wanting to provide advertising. If in doubt please contact the project leader
59-
- Be extremely generous with whitelisting
59+
- Be extremely generous with allowlisting
6060
- Don't delete any message unless it is a duplicated message (sent twice) or totally empty (no attachment and no body)
6161
- Any feedback about the app is obviously OK. Even hate mail (e.g. "This app sucks!") is OK.
6262
- The moderation interface is similar to this:

0 commit comments

Comments
 (0)