Skip to content

Commit 9f8e2f2

Browse files
committed
docs: add aoler to CONTRIBUTING.md — link to launcher guide, update all app references
1 parent 1d39731 commit 9f8e2f2

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You do not need to write code to contribute. Here are all the ways you can help:
1515
3. Improve documentation — fix unclear steps or add missing information
1616
4. Test builds — install nightly APKs and report what you find
1717
5. Translate — help make BAOSP accessible in more languages
18-
6. Write code — fix bugs or add features in andrdscren, aotts, or the AOSP patches
18+
6. Write code — fix bugs or add features in andrdscren, aotts, aoler, or the AOSP patches
1919

2020
---
2121

@@ -33,10 +33,11 @@ For code contributions to the AOSP build system, you also need:
3333
5. At least 16 GB of RAM
3434
6. A fast internet connection — the AOSP source download is about 100 GB
3535

36-
For contributions to the apps only (andrdscren or aotts), see their own guides:
36+
For contributions to the apps only (andrdscren, aotts, or aoler), see their own guides:
3737

3838
- Screen reader: github.com/tech-master33/andrdscren/blob/main/CONTRIBUTING.md
3939
- TTS engine: github.com/tech-master33/aotts/blob/main/CONTRIBUTING.md
40+
- Launcher: github.com/tech-master33/aoler/blob/main/CONTRIBUTING.md
4041

4142
---
4243

@@ -56,6 +57,7 @@ For a bug report include:
5657
- Whether it happens every time or only sometimes
5758
- Your Android version and device model
5859
- Which version of the BAOSP APKs you installed (check the nightly release tag)
60+
- Which app is affected — andrdscren, aotts, aoler, or the OS itself
5961

6062
For a feature request include:
6163
- What task are you trying to accomplish
@@ -181,6 +183,23 @@ Then:
181183

182184
---
183185

186+
## Contributing code — app repos
187+
188+
Each app has its own repository and its own contributor guide.
189+
Changes to the apps go into their own repos, not into baosp directly.
190+
191+
| App | Repository | Contributor guide |
192+
|-----|-----------|------------------|
193+
| Screen reader | github.com/tech-master33/andrdscren | CONTRIBUTING.md in that repo |
194+
| TTS engine | github.com/tech-master33/aotts | CONTRIBUTING.md in that repo |
195+
| Home screen launcher | github.com/tech-master33/aoler | CONTRIBUTING.md in that repo |
196+
197+
The nightly bundle in baosp picks up the latest `main` of each app repo automatically every night.
198+
You do not need to touch baosp to get an app change into the nightly release —
199+
merging your pull request in the app repo is enough.
200+
201+
---
202+
184203
## Accessibility rules for all code contributions
185204

186205
Every code change to this project must follow these rules.
@@ -216,6 +235,7 @@ If you have not heard back after a week, add a comment to the pull request to as
216235
- Issues: github.com/tech-master33/baosp/issues
217236
- Screen reader source: github.com/tech-master33/andrdscren
218237
- TTS engine source: github.com/tech-master33/aotts
238+
- Launcher source: github.com/tech-master33/aoler
219239

220240
Open a discussion if you have a question. Describe what you are trying to do and where you are stuck.
221241
You do not need to have a solution — questions about how things work are welcome.

0 commit comments

Comments
 (0)