Skip to content

Commit

Permalink
Install Git [Link to Download] - Getting_Started.md (#652)
Browse files Browse the repository at this point in the history
* Added item 2 - install git in the getting_started.md

* Removed a line and ordered lists went from 1,2,3,4 to 1,1,1,1 for future flexibility.
  • Loading branch information
erwinmedina committed Oct 31, 2022
1 parent d48a1c1 commit 2bb356c
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions GETTING_STARTED.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
## Getting started

1. Install [Node 16 LTS](https://nodejs.org/en/)
2. Install and get familiar with [Git](https://docs.github.com/en/get-started/quickstart/hello-world)
- If you are not comforable with the Git command line tool, you may use GitHub Desktop (<https://desktop.github.com/>). Take a look at <https://acmcsuf.com/1st/> if this is your first time contributing to an open source project.
3. Create a fork of [acmcsuf.com](https://github.com/EthanThatOneKid/acmcsuf.com), similar to <https://github.com/jaasonw/acmcsuf.com>
4. Create an account on [Vercel](https://vercel.com/) and create a new project linked to the fork you just created, similar to <https://acmcsuf-wayson.vercel.app/>
5. Create an [access token](https://scribehow.com/shared/Generating_a_personal_access_token__eMf0UJYaS5OcGrO_lJTpGg)
6. Follow [these instructions](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md#setting-up-your-env-file) to add it to your dev environment
1. Install [Git](https://git-scm.com/downloads)
- If you are not comfortable with the Git command line tool, you may use GitHub Desktop (<https://desktop.github.com/>). Take a look at <https://acmcsuf.com/1st/> if this is your first time contributing to an open source project.
1. Create a fork of [acmcsuf.com](https://github.com/EthanThatOneKid/acmcsuf.com), similar to <https://github.com/jaasonw/acmcsuf.com>
1. Create an account on [Vercel](https://vercel.com/) and create a new project linked to the fork you just created, similar to <https://acmcsuf-wayson.vercel.app/>
1. Create an [access token](https://scribehow.com/shared/Generating_a_personal_access_token__eMf0UJYaS5OcGrO_lJTpGg)
1. Follow [these instructions](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md#setting-up-your-env-file) to add it to your dev environment

## Local development setup

1. Create a local clone of your **FORKED** repository
2. Open a terminal inside your local clone and run `npm i` to install the required dependencies (We use svelte for much of the codebase along with Typescript and some utility libraries)
3. Run `npm start` (or `npm run dev`) to boot up the local development server and navigate to `localhost:5173` in your web browser and you should have a local copy of the website
1. Open a terminal inside your local clone and run `npm i` to install the required dependencies (We use svelte for much of the codebase along with Typescript and some utility libraries)
1. Run `npm start` (or `npm run dev`) to boot up the local development server and navigate to `localhost:5173` in your web browser and you should have a local copy of the website

## Pushing a code change

1. Create a new branch, **DO NOT** work directly off the main branch
2. Open `src/routes/+page.svelte`, this is the root of the website, in other words, the front page when you visit the website
3. Go ahead and change the title of the website to anything you want and head over to `src/routes/hero.svelte` and change the text of the header
4. Whenever applicable (it’s not in this case), write unit tests for any new functions or components you create
5. Once you’re satisfied your changes, you **MUST** use `npm run all` to run all tests, lints, and formatting necessary for a release build, otherwise the automated build test will fail
6. Commit and push your changes
7. Go to your Vercel dashboard and verify that a preview deployment was pushed, similar to <https://acmcsuf-wayson-rbe1c3cul-jaasonw.vercel.app/>
1. Open `src/routes/+page.svelte`, this is the root of the website, in other words, the front page when you visit the website
1. Go ahead and change the title of the website to anything you want and head over to `src/routes/hero.svelte` and change the text of the header
1. Whenever applicable (it’s not in this case), write unit tests for any new functions or components you create
1. Once you’re satisfied your changes, you **MUST** use `npm run all` to run all tests, lints, and formatting necessary for a release build, otherwise the automated build test will fail
1. Commit and push your changes
1. Go to your Vercel dashboard and verify that a preview deployment was pushed, similar to <https://acmcsuf-wayson-rbe1c3cul-jaasonw.vercel.app/>

## Submitting a pull request for review

1. Once you’re ready to submit your changes for review, head back over to the [main repository](https://github.com/EthanThatOneKid/acmcsuf.com) and click on Pull Requests → New pull request
2. Your pull request should contain
1. Your pull request should contain
1. A clear and descriptive title (Please do not use “Fixed #123”)
2. A clear description that describes, in detail, what you changed and how
3. A link to the issue that you resolved (if applicable)
4. Any screenshots if your change affects something visible on the website or that you believe would help the reviewer understand your changes
5. Examples of good PRs
1. A clear description that describes, in detail, what you changed and how
1. A link to the issue that you resolved (if applicable)
1. Any screenshots if your change affects something visible on the website or that you believe would help the reviewer understand your changes
1. Examples of good PRs
1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/477](https://github.com/EthanThatOneKid/acmcsuf.com/pull/477)
2. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/469](https://github.com/EthanThatOneKid/acmcsuf.com/pull/469)
3. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/401](https://github.com/EthanThatOneKid/acmcsuf.com/pull/401)
6. Examples of bad PRs
1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/469](https://github.com/EthanThatOneKid/acmcsuf.com/pull/469)
1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/401](https://github.com/EthanThatOneKid/acmcsuf.com/pull/401)
1. Examples of bad PRs
1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/359](https://github.com/EthanThatOneKid/acmcsuf.com/pull/359)
2. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/357](https://github.com/EthanThatOneKid/acmcsuf.com/pull/357)
3. Request a code review from someone by first contacting them and then assigning them to your PR using the “Reviewers” panel
4. Address any feedback from your reviewers if applicable
5. Once your changes have been approved, you have permission to merge your changes, and your changes should be merged with a **SQUASH** and **NOT** a merge commit
1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/357](https://github.com/EthanThatOneKid/acmcsuf.com/pull/357)
1. Request a code review from someone by first contacting them and then assigning them to your PR using the “Reviewers” panel
1. Address any feedback from your reviewers if applicable
1. Once your changes have been approved, you have permission to merge your changes, and your changes should be merged with a **SQUASH** and **NOT** a merge commit

## Further reading

Expand Down

1 comment on commit 2bb356c

@vercel
Copy link

@vercel vercel bot commented on 2bb356c Oct 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.