From e3491f8afb0bab7c78f0a75ebf7398cee00cc6e0 Mon Sep 17 00:00:00 2001 From: Justin Shillingford Date: Tue, 23 Jun 2020 16:42:00 -0400 Subject: Added pull_request_template.md This is a (slightly modified) template I found on https://www.talater.com/open-source-templates/#/page/1. Since we likely won't be making any pull requests immediately, this is still up to changing from feedback (and the more feedback the merrier!). And whatever version ends up being pulled into the main repository, we can discuss in sprint retro and make modifications as necessary. --- .github/pull_request_template.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..8606ee25 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ + + +## Link to ticket + + +## Description + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. -- cgit v1.2.3-70-g09d2 From b92ff5da4dfe30620ad8c2c2eae027c33781701e Mon Sep 17 00:00:00 2001 From: Justin Shillingford Date: Tue, 23 Jun 2020 16:56:33 -0400 Subject: Update pull_request.md Added Documentation/repository update option to Types of changes --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8606ee25..5445a12e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,6 +18,7 @@ - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation/repository update ## Checklist: -- cgit v1.2.3-70-g09d2 From 467c3de3e7804b1a3b05e94de83a8e32b7f11d41 Mon Sep 17 00:00:00 2001 From: Leon Jiang Date: Wed, 24 Jun 2020 00:21:44 -0700 Subject: Add setup instructions to README --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9301f3b6..a017a3d7 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# Frontend \ No newline at end of file +# Frontend +## Setup +Welcome! Before you get coding, there's a few setup-related tasks to complete. Specifically, you'll have to **1) fork the repo**, and **2) install the necessary development tools**. After that, you should be able to get up and running. There's no way (that I currently know of) for Windows users to develop on iOS, but I am positive workarounds exist and will include those later. + +### 1) Git going +First, you'll need to fork the Frontend repo *and* sync it upstream. If you've already done this, skip to step 2). + +*To fork the repo*, simply click the "Fork" button near the top right of this page. If prompted to select "where" to fork it, click your username. + +*To clone your forked repo* to your local file system, first, navigate to the forked repo in your browser (**not** the original repository) if you aren't already there. Click the large green "Clone" button, and copy the URL onto your clipboard. Then, open a terminal window, navigate to where you want the project to live on your local file system (my recommendation is in a directory named "tagg" where you store both your frontend & backend projects), and run the following command, replacing the dummy URL with your clipboard: + +`git clone https://github.com/your-username/Frontend.git` + +You'll be prompted for your GitHub username & password, which you should enter. If, when working with GitHub in the future, you don't want to enter your credentials each time, check out [this guide](https://help.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh). + +Now you have a local copy of the project on your computer, but it's not synced up with the original repository, so it won't detect changes in the main project. To sync your fork upstream, navigate to your project in a terminal window if you're not already there. Inside your project directory, run the command + +`git remote add upstream https://github.com/TaggiD-Inc/Frontend.git` + +Double check that this worked by running + +`git remote -v` + +in your project directory. In addition to the two "origin" remotes, you should see two more "upstream" remotes. + +If you've made it here with no errors, congratulations! A forked version of the frontend project directory now lives on your local file system, which you can begin editing. If not, feel free to consult your teammates. This process should be executed whenever you intend to work on a new feature (for the time being). + +Original instructions [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo). + +### 2) Devtools + +Follow the instructions on React Native's docs [here](https://reactnative.dev/docs/environment-setup) under "React Native CLI Quickstart", making sure to follow directions for *your operating system*, for *both target operating systems* (iOS and Android). Stop upon reaching the section "Creating a new application", as our project is already set uyp. + +*\* + +Now that you've forked your repo and installed your developer tools, you are ready to build and run your project. + +## Running +To build and run your project, open a terminal window, navigate to your project directory, and run `yarn ios` or `yarn android`. This should prompt Xcode / Android Studio, if they are properly configured, to launch a simulator, where you'll be able to view your code changes in real time (live reload on save). Happy coding! -- cgit v1.2.3-70-g09d2 From c17b072e04aaae2868bcbb0d88f86b9bb540de07 Mon Sep 17 00:00:00 2001 From: hsalhab Date: Wed, 24 Jun 2020 13:23:58 -0400 Subject: update CODEOWNERS --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index dae8a4a3..7f08bbc1 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -5,7 +5,7 @@ # the repo. Unless a later match takes precedence, # @gusu6928 and @hsalhab will be requested for # review when someone opens a pull request. -#* @grusu6928 @hsalhab +* @hsalhab # Order is important; the last matching pattern takes the most # precedence. -- cgit v1.2.3-70-g09d2 From 327e1b340bbf9254d1d5e232df0fef1fdab91d2b Mon Sep 17 00:00:00 2001 From: hsalhab Date: Wed, 24 Jun 2020 13:26:42 -0400 Subject: update CODEOWNERS --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 7f08bbc1..f0df1efa 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -5,7 +5,7 @@ # the repo. Unless a later match takes precedence, # @gusu6928 and @hsalhab will be requested for # review when someone opens a pull request. -* @hsalhab +* @hsalhab # Order is important; the last matching pattern takes the most # precedence. -- cgit v1.2.3-70-g09d2