CONTRIBUTING

# Contributing to this Project

The goals of all contributors is to give guidance to students who are on the CS/ECE track at CMU.
We want to give tips in a way that encourages learning and gives a student that is willing to
work hard a good chance at succeeding in the classes.

There can always be improvement made to articles. Therefore, don't be afraid to edit
articles that have already been written for classes.

Some guidelines:
 
 - Try to avoid saying things about professors, since they will change throughout the years
 - Also you can get in trouble for saying the wrong thing about professors, so best to avoid
 - Do not encourage cheating. If you must, you can always write problems of your own

## How to Contribute

1. Fork the repo. Comitting directly to `master` is not allowed. To do this, use the Github UI to create a fork (upper right hand corner for web)
2. Make your changes, and if your changes are for a new class, then add it to the table of contents, which is the `README.md` in the root directory. 
The format for the file is just 
```
folder/class_number.md
```
3. **Please use markdown**, unless you have styling that is absolutely unsupported. In that case, you may consider creating a new folder in the repo with other assets, like images or PDFs.
4. Once you're done, open a pull request from your branch to the master branch of this repo, and get it approved. Once it is approved, you can merge it to master.