PickHacks 2022 main site

View Live |

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Running locally
• Contributing

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Git
  • Setup Github SSH keys
• Node
• Yarn

Installation

1. Clone the pickhacks 2022 repository using Git Bash(make sure to have SSH keys setup):

   git clone git@github.com:acmhack/pickhacks-2022.git

Installation

1. Clone the pickhacks 2022 repository using Git Bash: bash git clone git@github.com:acmhack/pickhacks-2022.githttps://github.com/sigdotcom/mstacm.org.git

Running locally

1. Install dependencies using yarn:

   yarn

2. Start up a local server to run the website:

   yarn start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

We use a pattern known as Github Flow. Click that link to learn more.

ACM Hack Dev

Every feature:

1. Update your local master branch

   git switch master # "git checkout master" if git < 2.23
   git pull master

2. Create your branch

   git switch -c feature/<feature-name>

   where <feature-name> is replaced with a short description of your feature (ex. admin-permission-tool for a feature adding a new tool to admin-web)

   Name your commits with feature/ or hotfix/ at the beginning depending on the content of the branch. (ex. feature/new-icons, hotfix/icon-render-glitch)

3. Add and commit your Changes

   git add file1 file2 ... # only add relevant files
   git commit -m 'Add some great specific and well described features' # After the "-m" goes the commit message

   Read [this article about good commit messages] to maintain good quality commits

4. Push to the remote branch

   git push origin feature/<feature-name>

5. Open a Pull Request on Github

6. Grab a new issue to work on and start from the top!

Editing Branch Rules

A branch rule must have the same name as a branch in order for it to work correctly.

License

Distributed under the MPL-2.0 License. See LICENSE for more information.