Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 3.89 KB

Contributing to Nio

First off, thanks for taking the time to contribute! 😍🥳 There are several ways you can leave your mark, we're extremely glad to have you!

Feedback

At the current time, Nio is not yet ready for an actual release on the App Store. Many essential features are still missing. Current builds are distributed via TestFlight. We heavily rely on people installing these builds and telling us if other things are not yet working as expected or if there are bugs in the existing features.

Should you come across anything in that regard, be it as simple as a typo in the app's description, behavior that doesn't feel correct, a crash of the application or anything else, please reach out. Either by opening an issue directly on GitHub, sending a message in our Matrix room #niochat:matrix.org or via mail to [email protected].

Please also feel free to comment on existing issues and pull requests. A new opinion, viewpoint or even just an upvote is always good to have.

We know we're still far away from the goal, but Nio is aiming to be as inclusive as possible and while trying to do our best, we also rely on people like you telling us if things are anywhere between unclear and confusing or just downright wrong.

Thank you! ❤️

Localization

As Nio aims to be accessible by anyone from around the globe, it's important to have Nio speak as many languages as possible. Nio uses a tool called Weblate running on translate.riot.im to manage translation files. Unfortunately you do need an account there, but it's of course free and easy to register for one. After doing that you can fix and modify existing translations or add new languages altogether, both of which are highly appreciated!

If Weblate isn't to your liking and you prefer a text editor and git, feel free to edit the translations directly in the project's repository. They're synchronized both ways.

This is the current status of the translations:

Translation status

Custom App Icons

Nio includes a few basic app icons, but a bigger selection of community icons would be fantastic. All that's necessary to include a new icon is a 1024x1024px PNG file. Please don't include any rounded edges, iOS does that automatically. Check the Resources directory for the existing icons and the base chat bubbles in different formats if you want to build on that. You can send the finished file to our Matrix room or mail address (all listed on nio.chat) or just open a new issue on GitHub 😊

Implementation

Nio has (and probably always will have 😅) a long list of open issues. You are more than extremely welcome to tackle any of these and send pull requests.

Dependencies

Nio manages its dependencies via Swift package manager, which Xcode handles automatically. The matrix-ios-sdk however doesn't directly support SwiftPM, so we build our own compatible framework and pull it from niochat/MatrixSDK.

Automatic Signing

In order to use automatic signing in Xcode, it is possible to create Configs/LocalConfig.xcconfig and override the default values. For more info have a look here.

If you are unsure where to start or have other questions, please reach out, preferably via Matrix in #niochat:matrix.org or whatever works for you 😊