Anything wrong or missing? Learn how to help Calendarium!
1. Go to Calendarium
2. In the top right corner, click on Fork
1. Go to your fork and click Code
Note
The link to your forked repository should behttps://github.com/<your-username>/calendarium
2. Copy the given HTTPS link
3. On your terminal, run the following command:
git clone <https-link>
Note
If you'd rather clone with SSH, copy the SSH url and rungit clone <ssh-url>
Now you have a copy of the repository that you can work with.
Note
The following instructions are targeted for a Linux environment, you can however use the web-based editing capabilities of GitHub.
1. Move to your cloned repository directory with cd calendarium
2. Create a new branch with the following command:
git checkout -b <branch>
Where <branch>
is the name of your branch.
Note
The name of your branch should follow the CeSIUM guidelines:<first-letter-of-your-first-name><first-letter-of-your-last-name> + '/' + <branch-name>
. For example:dm/shifts
.
1. Move to the data
directory
2. Open the events.json
or shifts.json
to make changes to Events or Shifts
Understanding events.json
title
- event titleplace
- where the event takes place (optional)link
- a relevant link (optional)start
- date and time of when the event startsend
- date and time of when the event endsgroupId
- an ID composed of the course yearfilterId
* - an ID used for filtering
Note
ThefilterId
is composed of:<course-year><course-semester><curricular-unit-number>
. For example:221
(Bases de Dados). Check out thefilterId
of each class by searching its name onshifts.json
or checking theid
parameter infilters.json
.
Note For all-day events,
start
andend
should be equal and composed of:<event-date> 00:00
. And for multiple-days events:start: <event-start-date> 00:00
&end: <event-end-date> 23:59
. Check out the example below.
Check out this example:
{
"title": "[Lógica] Teste",
"place": "CP2 - 0.20 + 1.01 + 1.05 + 1.07 + 2.01 + 2.02",
"start": "2023-04-12 17:30",
"end": "2023-04-12 20:30",
"groupId": 1,
"filterId": 124
}
For All-Day events:
{
"title": "[POO] Entrega TP",
"start": "2023-05-14 00:00",
"end": "2023-05-14 00:00",
"groupId": 2,
"filterId": 224
}
For Multiple-Days events:
{
"title": "[POO] Apresentação TP",
"start": "2023-05-15 00:00",
"end": "2023-05-19 23:59",
"groupId": 2,
"filterId": 224
}
Understanding shifts.json
id
* - curricular unit idtitle
- title of the activitytheoretical
- 'true' for T and 'false' for TPshift
- class shiftbuilding
* - building where the class takes placeroom
- room where the class takes placeday
- week day (1 - Monday ... 4 - Friday)start
- time of when the activity startsend
- time of when the activity endsfilterId
* - an ID used for filtering
Note
The curricular unitid
is taken from the official UMinho Software Engineering Study Plan, available here. However, you should not have to change it.
Note
Thebuilding
parameter should be composed ofCP
+<building-number>
only for buildings 1, 2 and 3. For the remaining buildings it's simply composed of the building number.
Note
ThefilterId
is composed of:<course-year><course-semester><curricular-unit-number>
. For example:221
(Bases de Dados). Check out thefilterId
of each class by searching its name onshifts.json
or checking theid
parameter infilters.json
.
Check out this example:
{
"id": 14296,
"title": "Laboratórios de Informática II",
"theoretical": false,
"shift": "PL8",
"building": "CP2",
"room": "1.09",
"day": 3,
"start": "08:00",
"end": "10:00",
"filterId": 123
}
Note
You can get a local preview of your changes by running the project on your machine, follow the Contributing Guide to know more.
1. Stage your changes:
git add .
2. Commit your changes:
git commit -m "<commit-description>"
3. Push your changes to your forked repository:
git push
1. Go to your forked repository on the GitHub website
2. Select the branch you created from the dropdown menu
3. Click on Pull request
4. Add a convenient title and description to your pull request
5. Assign a contributor for review
If everything checks out, your pull request will be reviewed and approved shortly.
Visit the Calendarium website and check out your changes!