Skip to content

Latest commit

 

History

History
66 lines (37 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

66 lines (37 loc) · 3.94 KB
Raw

Contributing

Nos is an open-source project, as such, we openly welcome contributions of any sort: code improvement, bug fixes, translations, new features, bug reports, etc.

We encourage you to read this guide first or contact any of us. We have a public Discord server which is also bridged to this Matrix room. Feel free to also ask a question by opening a GitHub issue.

Translations

If you want to contribute by translating the app to another language, you can head in to our project in Crowdin and start translating there. It will automatically generate a Pull Request with your translations that we will happily take care of merging. If we haven't set up the langauge you would like to translate let us know by opening an issue or emailing [email protected]. Please do not edit the non-English translations in the .xcstrings files in this repository directly.

Building

Nos iOS is built using Xcode. To build it yourself you can follow the steps below. These steps assume you have installed Xcode, Homebrew, and have some familiarity with the Terminal app. You can see what version of Xcode our team is using in the .xcode-version file in this repository.

From the Terminal:

  1. brew install swiftlint

  2. git clone [email protected]:planetary-social/nos.git

  3. cd nos

  4. Open the Nos project in Xcode:

open Nos.xcodeproj

In Xcode:

  1. In the menu bar choose Product -> Build

Running

The app is fully functional in the iOS simulator. To run the app in the simulator, select a simulator using the Product -> Destination menu in Xcode, and then click Product -> Run. If you want to run it on a device you will need to change the Bundle Identifier and Code Signing settings to use your personal team.

Contributing Code

If you'd like to contribute code to the main branch of Nos, it's best to check with us first. The best way to do this is to open or comment on an issue describing your proposed change. Feel free to @-mention some of the maintainers if we don't respond in a reasonable amount of time.

We use SwiftLint to enforce many of our style conventions. When it comes to naming conventions we follow the Swift API Design Guidelines.

Periphery allows us to detect and delete unused code. One great way to contribute to Nos would be to run periphery, delete unused code, test the app, then submit a PR. We'd really appreciate it!

Opening a Pull Request

For now main is the main branch and code improvements are made in topic branches that get merged into it.

  1. Fork the repo and create a branch. Use a concise, descriptive name, like new-notes-available for a feature, or fix-home-feed-on-first-launch for a bug fix.
  2. Make your proposed changes and test them thoroughly. We’d love for you to add unit or integration tests as well.
  3. Open a PR with a short description of what the PR accomplishes, and a link to the corresponding issue.
  4. If your PR contains visual changes, add screenshots or a video. In the iOS Simulator, you can use File > Save Screen (⌘S) to take a screenshot or File > Record Screen (⌘R) to take a video.

A maintainer will review your code and merge it when it has the required number of approvals.

Dependency Management

We prefer to install dependencies using the Swift Package Manager.

Releasing

We build and release using Fastlane. You can set up fastlane like this:

  1. Install command line tools xcode-select --install
  2. Install fastlane: brew install fastlane or gem install fastlane
  3. Get the Apple Developer API Key from another team member and place it in $HOME/.fastlane.