From 462c686af22a3ac1959d32f889558fe9cf0dea36 Mon Sep 17 00:00:00 2001 From: magnus2142 <magnus.bredeli@hotmail.com> Date: Sun, 15 May 2022 11:17:46 +0200 Subject: [PATCH] updated contributing.md --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 57 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec64336..fe97f54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 -- GitLab