Skip to content

Commit cbdb941

Browse files
committed
Add CONTRIBUTING to detail what contributors/maintainers do
1 parent bef3709 commit cbdb941

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- [ ] I understand that GitHub is only a read-only mirror of the KDE project and will instead open a merge request on [KDE's GitLab](https://invent.kde.org/network/kdeconnect-ios)

CONTRIBUTING.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Getting Involved with KDE Connect iOS
2+
3+
There are many aspects of contributing to and help maintaining the KDE Connect iOS project.
4+
5+
## Contributors
6+
7+
### Adding Features, Documentation, and Fixing Bugs
8+
9+
Checking and updating [Bugs](https://bugs.kde.org/buglist.cgi?cmdtype=runnamed&list_id=2392382&namedcmd=KDE%20Connect%20iOS)
10+
and [Phabricator](https://phabricator.kde.org/project/board/159/) tasks (tagged `iOS`),
11+
as well as documenting about how to use/develop KDE Connect iOS are all valuable contributions
12+
through either [KDE's GitLab](https://invent.kde.org/network/kdeconnect-ios) or one of the Wiki's:
13+
14+
- [KDE Connect iOS](https://invent.kde.org/network/kdeconnect-ios/-/wikis/home)
15+
- [Community](https://community.kde.org/KDEConnect)
16+
- [UserBase](https://userbase.kde.org/KDEConnect)
17+
18+
### Performing Code Review
19+
20+
Testing the application to see if the app works as intended and/or
21+
to see if the code follows best practices. Here's a checklist that might be helpful:
22+
[Reviewing Merge Requests](https://invent.kde.org/network/kdeconnect-ios/-/wikis/Reviewing-Merge-Requests)
23+
24+
### Spreading the Words
25+
26+
Many open source beginners are looking for exciting projects to join,
27+
and you can let them know about KDE Connect and other KDE projects.
28+
Especially for KDE Connect iOS, the people who can help out the most (iOS developers)
29+
are likely unfamiliar with KDE community, so going to communities
30+
such as [Xcoders](https://xcoders.org) and [iOS Dev Happy Hour](https://www.iosdevhappyhour.com),
31+
regional events like [try! Swift](https://www.tryswift.co)
32+
or global conferences like [WWDC](http://developer.apple.com/wwdc),
33+
or posting to online forums like [r/swift](https://www.reddit.com/r/swift/) on Reddit,
34+
sharing your experiences working on KDE Connect iOS
35+
or deliver talks about knowledge you learned by working with this project
36+
can all be great ways to increase liveliness with this project.
37+
38+
## Maintainers
39+
40+
Once you've become a frequent contributor to the KDE Connect iOS project,
41+
an existing maintainer can recommend you to join KDE's Apple Developer team
42+
and access App Store Connect, which allows you to
43+
44+
- upload new TestFlight public beta builds and fill in the release notes,
45+
+ ideally, this should be automated
46+
- make a new release for everyone to download from App Store
47+
+ the next beta build needs a new Version number and takes longer to be reviewed by App Store review team),
48+
- see crash reports and tester feedback to prioritize high-impact and triage obscure bugs, and
49+
- answering customer reviews from App Store
50+
+ they'll get you reply as an email!
51+
+ you can also search online (e.g. Reddit, YouTube) to see what people are complaining about
52+
and see how we can change to improve the user experience
53+
54+
Don't know how? Check out [Wiki](https://invent.kde.org/network/kdeconnect-ios/-/wikis/home#app-store-releases-and-beta-testing)
55+
or documentation from Apple Developer site.

0 commit comments

Comments
 (0)