Skip to content

Commit d789cc1

Browse files
committed
doc: Add section on getting help with codebase
Apparently we didn't actually say anywhere in these docs where one should go to ask for help with contributing! (Though we did link to some Zulip-wide resources that included links to the right channel.) Fix that. And take the opportunity to stress the community norms; we often see new participants who ask for help that clearly haven't read them.
1 parent 0f80c31 commit d789cc1

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,26 @@ and describing your progress.
5858
[picking an issue to work on]: https://zulip.readthedocs.io/en/latest/contributing/contributing.html#picking-an-issue-to-work-on
5959

6060

61+
<div id="getting-help" />
62+
63+
### Asking questions, getting help
64+
65+
To ask for help with working on this codebase, use the
66+
[`#mobile-dev-help`][mobile-dev-help] channel on chat.zulip.org.
67+
Before participating there for the first time,
68+
be sure to take a minute to read our
69+
[community norms][norms-getting-help].
70+
71+
For more in-depth advice on how to go beyond the minimum
72+
represented by our community norms, see
73+
Zulip's [guide to asking great questions][]
74+
and the resources linked from there.
75+
76+
[mobile-dev-help]: https://chat.zulip.org/#narrow/stream/516-mobile-dev-help
77+
[norms-getting-help]: https://zulip.com/development-community/#getting-help
78+
[guide to asking great questions]: https://zulip.readthedocs.io/en/latest/contributing/asking-great-questions.html
79+
80+
6181
### Submitting a pull request
6282

6383
Follow the Zulip project's guide to your first codebase contribution
@@ -116,6 +136,8 @@ see our [full setup guide](docs/setup.md).
116136

117137
If you're having trouble or seeing errors, take a look through our
118138
[troubleshooting section](docs/setup.md#troubleshooting).
139+
If that doesn't resolve the issue, see the section above on
140+
[how to ask for help](#getting-help).
119141

120142

121143
### Flutter version

0 commit comments

Comments
 (0)