Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 2.86 KB
Raw

Contributing to BinaryClock

Thank you for your interest in contributing to BinaryClock! There are lots of ways you can do so:

The rest of this document will focus on that last bullet point, providing a guide to setting up your development environment so you can bring your ideas for BinaryClock to life.

Development Setup

Start by following the React Native CLI Quickstart from the official docs.

Then install fastlane: https://fastlane.tools/

Then fork and clone this repository to your machine.

Then copy fastlane/.env.dist to fastlane/.env

From there you can start experimenting with making any changes you like!

Directory Structure

Nearly all development on Binary Clock occurs within the src folder. Here's what each subfolder contains:

  • components: Individual, reusable UI components for the clock and its settings page.
  • pages: Complete screens for the app.
  • utils: The backend logic for storing and retriving user settings from persistent storage.

Submitting Contributions

After completing the installation steps above, make whatever bug fixes or improvements you want in the codebase.

When you are done, simply commit your code with a brief message explaining what was changed, and why. A series of automated checks will run to make sure everything looks good before the commit gets saved:

  • The unit test suite will automatically run and inform you of any failing tests that need fixing.
  • Linters will automatically run and correct any code formatting problems. Make sure to git add . after these run to capture their changes.

Finally push up your changes to your fork and open a Pull Request (PR) back into thehale/BinaryClock.

  • A bot will post a link on your PR asking you to sign a standard Contributor License Agreement (CLA) giving me permission to integrate your contribution into the project.
  • Any questions about your contribution will be discussed within the PR's comment section.
  • After everything looks great, your PR will be merged into the main branch of BinaryClock!

Other Notes

Creating a Release Build

Fill out all the credentials in fastlane/.env (make a copy of fastlane/.env.dist if it doesn't exist yet).

Then see fastlane/README.md for the commands.