Skip to content

Commit

Permalink
Prep app for 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
axelclark committed Dec 23, 2018
1 parent 9bfffb6 commit 706b042
Show file tree
Hide file tree
Showing 6 changed files with 188 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## 0.1.0

* Initial release
117 changes: 117 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# How to contribute

I'm really glad you're reading this, because contributions are very welcome. This is my first React-Native app so any recommended improvements are appreciated. Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved!

We currently use the [Issue Tracker](https://github.com/axelclark/golf-mobile/issues) to track and discuss bugs, features, and any other topics related to the project.

## Pull Requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

**IMPORTANT**: By submitting a patch, you agree that your work will be licensed under the license used by the project.

If you have any large pull request in mind (e.g. implementing features, refactoring code, etc), **please ask first** otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions in the project (indentation, accurate comments, etc.) and don't forget to add your own tests and documentation. When working with git, we recommend the following process in order to craft an excellent pull request:

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/golf-mobile
# Navigate to the newly cloned directory
cd golf-mobile
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/axelclark/golf-mobile
```

2. Verify project runs on your machine.

```bash
yarn install
yarn start
```

3. If you cloned a while ago, get the latest changes from upstream, and update your fork:

```bash
git checkout master
git pull upstream master
git push
```

4. Create a new topic branch (off of `master`) to contain your feature, change, or fix.

**IMPORTANT**: Making changes in `master` is discouraged. You should always keep your
local `master` in sync with upstream `master` and make your changes in topic branches.

```bash
git checkout -b <topic-branch-name>
```

5. When feature is complete and tests pass, stage the changes.

```bash
git add --all
```

6. When you've staged the changes, commit them.
```bash
git status
git commit --verbose
```
7. Write a [good commit message]. Example format:
```bash
Present-tense summary under 50 characters
* More information about commit (under 72 characters).
* More information about commit (under 72 characters).
* Closes #XX
```
8. If you've created more than one commit, [use `git rebase` interactively](https://help.github.com/articles/about-git-rebase/) to squash them into cohesive commits with good messages:

```bash
git rebase -i origin/master
```

9. Make sure all the tests are still passing. See additional info in the [Testing](#testing) section below.

```bash
yarn test
```

10. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

11. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description. [Ebert](https://ebertapp.io/github/axelclark/golf-mobile) will do an automated Code Review, see [Code Conventions](#code-conventions) below.

12. If you haven't updated your pull request for a while, you should consider rebasing on master and resolving any conflicts.
**IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You should always
`git rebase` on `master` to bring your changes up to date when necessary. See below.
```bash
git checkout master
git pull upstream master
git checkout <your-topic-branch>
git rebase master
```
## Code Conventions
Comming Soon...
## Testing
Comming Soon...
Thanks,
Axel
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# ForeScore

A simple IOS app project to keep track of disc golf rounds.

## Create React Native App

This React Native project was bootstrapped with [Expo](https://https://expo.io/).

## Available Scripts

### `yarn start`

Runs your app in development mode.

Open it in the [Expo app](https://expo.io) on your phone to view it. It will reload if you save edits to your files, and you will see build errors and logs in the terminal.

Sometimes you may need to reset or clear the React Native packager's cache. To do so, you can pass the `--reset-cache` flag to the start script:

```
yarn start --reset-cache
```

### `yarn test`

Runs the [jest](https://github.com/facebook/jest) test runner on your tests.

### `yarn run ios`

Like `yarn start`, but also attempts to open your app in the iOS Simulator if you're on a Mac and have it installed.

### `yarn run android`

Like `yarn start`, but also attempts to open your app on a connected Android device or emulator. Requires an installation of Android build tools (see [React Native docs](https://facebook.github.io/react-native/docs/getting-started.html) for detailed setup). We also recommend installing Genymotion as your Android emulator. Once you've finished setting up the native build environment, there are two options for making the right copy of `adb` available to Create React Native App:

## Contributing

See [CONTRIBUTING](https://github.com/axelclark/golf-mobile/blob/master/CONTRIBUTING.md) for information and instructions on contributing to this project.
21 changes: 21 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Release Procedures

1. Update [CHANGELOG.md](https://github.com/axelclark/golf-mobile/blob/master/CHANGELOG.md) with next release number
2. Update version in [app.json](https://github.com/axelclark/golf-mobile/blob/master/app.json)
3. Push changes to `master`
4. Add new [release](https://github.com/axelclark/golf-mobile/releases) on GitHub
5. Save new snapshots for App Store
6. Run `exp build:ios` from Shell
7. After the command completes it will provide a url to downloard the app file
8. Now add the build with Xcode
* From the Xcode menu scroll to Open Developer Tool and Choose Application Loader from the menu
* Click choose and select the build that you downloaded earlier from the expo link
9. Log in to [App Store Connect](https://appstoreconnect.apple.com/)
10. Go to most recent `iOS App` then `+ Version`
11. Add `What's New in This Version`, using `-` for each bullet
12. Update screen shots:
* 5.5-Inch Retina Display `1242 x 2208` pixels for portrait
* 5.8-Inch Super Retina Display `1125 x 2436` pixels for portrait
13. Once build is done processing, add build to new version and submit for review

Procedures from [How to Deploy a Create-React-Native-App to the App Store](https://codeburst.io/how-to-deploy-a-create-react-native-app-to-the-appstore-229a8fa36fb1)
13 changes: 8 additions & 5 deletions app.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
{
"expo": {
"name": "golf-mobile",
"slug": "golf-mobile",
"name": "ForeScore",
"slug": "fore-score",
"privacy": "public",
"sdkVersion": "31.0.0",
"platforms": [
"ios",
"android"
],
"version": "1.0.0",
"version": "0.1.0",
"orientation": "portrait",
"ios": {
"bundleIdentifier": "com.axel.fore-score"
},
"icon": "./assets/images/icon.png",
"splash": {
"image": "./assets/images/splash.png",
Expand All @@ -25,6 +28,6 @@
"ios": {
"supportsTablet": true
},
"description": ""
"description": "Easily keep track of disc golf scores"
}
}
}
Binary file modified assets/images/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 706b042

Please sign in to comment.