Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Saloni Vaishnav committed Aug 20, 2024
1 parent 3e9561d commit 938cb14
Showing 1 changed file with 13 additions and 21 deletions.
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
IllinoisWCS.github.io
=====================

# About
## About

This is the main website for Women in Computer Science at UIUC.
Current owners are Neha Vardhaman (@neha-vard) and Anushri Mittal (@Anushri-Mittal).
This is the main website for Women in Computer Science at UIUC. It is deployed at https://illinoiswcs.org and https://wcs.illinois.edu
Current owners are Saloni Vaishnav (@inolasv) and Firmiana Wang (@firmianaw).

# Making Edits
## Local Development

Set up a simple http server to view edits you make locally. [This guide](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server) should help with that. Refresh the localhost tab to view changes after saving them in your code editor.
To install and set up locally, first run `npm i` and then `npm run dev`. The application will run on http://localhost:3000

# Pull Requests
## Technologies

This application is built with Next.js


## Pull Requests

Please never commit to master, even if you have permission.
Run all changes by the Head of Infrastructure. Here are the steps to making a change and solving an issue:
Run all changes by the Infrastructure Chairs. Here are the steps to making a change and solving an issue:

1) Make a branch off ```master```. Please give it a descriptive message.

Expand All @@ -23,17 +28,4 @@ Run all changes by the Head of Infrastructure. Here are the steps to making a ch

4) Once you're ready, create a pull request with base as the ```master```.

5) Write a descriptive title and comment. You can reference the associated issue with a #.

# Style Guide
* You can do tabs or spaces, but please set your tab to 4 spaces.

* Use camelCase, not snake_case.

* Put braces on the right.

* Lines should not be longer than 80 characters.

* Put a comment above each function describing what it does.

* Alphabetize your CSS.
5) Write a descriptive title and comment. You can reference the associated issue with a #.

0 comments on commit 938cb14

Please sign in to comment.