Skip to content
Snippets Groups Projects
Commit 462c686a authored by magnus2142's avatar magnus2142
Browse files

updated contributing.md

parent bb56fdbe
No related branches found
No related tags found
No related merge requests found
......@@ -5,11 +5,10 @@
> feature request, you are agreeing to comply with this waiver of copyright interest.
> Details can be found in our [TERMS](TERMS.md) and [LICENSE](LICENSE).
There are two primary ways to help:
- Using the issue tracker, and
- Changing the code-base.
- Using the issue tracker, and
- Changing the code-base.
## Using the issue tracker
......@@ -21,7 +20,6 @@ Use the issue tracker to find ways to contribute. Find a bug or a feature, menti
the issue that you will take on that effort, then follow the _Changing the code-base_
guidance below.
## Changing the code-base
Generally speaking, you should fork this repository, make changes in your
......@@ -31,6 +29,61 @@ Additionally, the code should follow any stylistic and architectural guidelines
prescribed by the project. In the absence of such guidelines, mimic the styles
and patterns in the existing code-base.
## Setup the project
Follow this quick guide to clone and setup the project and be able to run and develop the project on your own computer.
1. Clone GitLab project
**With SSH:**
```Shell
git clone git@gitlab.stud.idi.ntnu.no:mattiaae/idatt2900-072.git
cd idatt2900-072
```
**With HTTPS:**
```Shell
git clone https://gitlab.stud.idi.ntnu.no/mattiaae/idatt2900-072.git
cd idatt2900-072
```
2. Create a virtual environment inside project folder
```Shell
virtualenv venv
source venv/bin/activate
Install all the requirements
python -m pip install -r requirements.txt
```
3. Setup bb script inside the root of the
```Shell
project
pip install --editable . OR pip3 install --editable .
```
At last, enter “bb” and a help page with list of commands should pop up like this:
```Shell
(venv) user@data:~/gitlab/idatt2900-072$ bb
Usage: bb [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
announcements Commands for listing, creating, deleting and updating...
assignments Commands for creating, listing and submitting assignments
contents Commands for listing, creating, deleting, updating and...
courses Commands for listing courses
login Authorize user with username and password
logout Logout user
```
## Browser support
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment