Skip to content

Commit 9867f76

Browse files
committed
doc: Update README and CONTRIBUTING to reflect the Flutter migration
1 parent 93aeee9 commit 9867f76

File tree

2 files changed

+57
-8
lines changed

2 files changed

+57
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
## Contributing
22

3+
**This app is in [maintenance mode][]**, and we're therefore no longer
4+
able to spend time reviewing PRs from contributors.
5+
6+
Instead, if you're interested in contributing to Zulip's mobile apps,
7+
see [the new Flutter-based app][zulip-flutter].
8+
9+
[maintenance mode]: https://github.com/zulip/zulip-flutter#maintenance-mode
10+
[zulip-flutter]: https://github.com/zulip/zulip-flutter
11+
12+
13+
## Previous information
14+
15+
The details below are from when this app was in active development.
16+
Some details may still be useful, but bear in mind that this
17+
app is in maintenance mode as described above.
18+
319
* **Start** by reading our [developer guide](docs/developer-guide.md).
420

521
* **Review** [open issues][open-issues] and submit a pull request.

README.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,46 @@ You can also help out by [running beta versions](#using-the-beta) of
2424
the app, and reporting bugs!
2525

2626

27-
## Contributing
27+
## Maintenance mode
28+
29+
This codebase built on React Native is a **legacy app, which is in
30+
maintenance mode** as we [focus on building][zulip-flutter-beta]
31+
a [new Zulip mobile app with Flutter][zulip-flutter].
32+
This means:
33+
34+
* This repository is the source code of the app we're still
35+
distributing and recommending for most users, until the new app is
36+
fully built and ready to replace it.
37+
38+
* Feedback is still welcome. Some bugs and feature requests will be
39+
naturally resolved by the new app; others won't, and we'll transfer
40+
them over when the time comes as issues on the new app. We're
41+
happy to do the work of identifying which is which — it's usually
42+
easy for us, given the time we've spent in both codebases.
43+
44+
* The development work we do in this repo is kept to a minimum: we
45+
fix critical bugs, and we add support for a few of the new features
46+
being added to Zulip on the web and desktop, those where the
47+
leverage from mobile support is highest.
48+
49+
* We aren't able to spend significant time investigating other bugs,
50+
or reviewing PRs from contributors. We're investing that time
51+
instead in getting the new Flutter app finished and into all our
52+
users' hands as soon as possible.
53+
54+
[zulip-flutter-beta]: https://chat.zulip.org/#narrow/stream/2-general/topic/Flutter/near/1582367
55+
[zulip-flutter]: https://github.com/zulip/zulip-flutter
56+
57+
58+
## Contributing (old)
59+
60+
If you're interested in contributing to Zulip's mobile apps,
61+
see [the new Flutter-based app][zulip-flutter].
62+
63+
Details below are from when this app was in active development.
64+
Some details may still be useful, but **bear in mind that this
65+
app is in maintenance mode** as described above.
2866

29-
Everyone is welcome to contribute. We gladly accept patches, pull requests,
30-
bug reports, or any other improvements. Read below to see how you can get
31-
started.
3267

3368
### Discussion
3469

@@ -68,9 +103,7 @@ started with the code, follow this doc:
68103
* [Developer Guide](docs/developer-guide.md)
69104

70105
Then see our [Contribution Guidelines](CONTRIBUTING.md), and come say
71-
hello in [the #mobile stream](#discussion). Issues tagged
72-
**[help wanted](https://github.com/zulip/zulip-mobile/labels/help%20wanted)**
73-
are a great starting point for PRs.
106+
hello in [the #mobile stream](#discussion).
74107

75108
For more reading, take a look at our [developer docs](docs/).
76109

@@ -85,7 +118,7 @@ Zulip Mobile supersedes two legacy Zulip apps,
85118

86119
## License
87120

88-
Copyright (c) 2016-2022 Kandra Labs, Inc., and contributors, and 2016 Dropbox, Inc.
121+
Copyright (c) 2016-2024 Kandra Labs, Inc., and contributors, and 2016 Dropbox, Inc.
89122

90123
Licensed under the Apache License, Version 2.0 (the "License");
91124
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)