Skip to content

Commit dc8d490

Browse files
Matthew-DobsonCopilot
Matthew-Dobson
and
Copilot
authored
Filled out docs for contributions.md (#835)
* Filled out docs for contributions.md * Update CONTRIBUTIONS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTIONS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTIONS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTIONS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTIONS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Revise contributing guidelines and workflow steps Updated the contributing guidelines to reflect changes in the workflow and improve clarity. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 9d6dc9e commit dc8d490

1 file changed

Lines changed: 99 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Contributing
2+
3+
This document outlines the full process for creating, working on, and merging tickets within the FGCS repository.
4+
All steps can be completed directly through GitHub and VS Code.
5+
6+
---
7+
8+
## Creating a Ticket
9+
10+
Navigate to the **Kanban board** on GitHub, decide which column your ticket belongs in, and click the **“Add item”** button at the bottom.
11+
12+
<p align="center">
13+
<img width="1274" height="742" alt="image" src="https://github.com/user-attachments/assets/73d45392-fa9c-4ee0-83f7-53e009584363" />
14+
</p>
15+
16+
Then click the small **“+”** on the lower left-hand side and select **“Create new issue.”**
17+
18+
<p align="center">
19+
<img width="1280" height="743" alt="image" src="https://github.com/user-attachments/assets/23bf0b32-bb68-4abc-861c-a58c2a6b8ee2" />
20+
</p>
21+
22+
Fill in all required details clearly and concisely.
23+
24+
> 💡 **Tip:** Write your ticket titles in a short, descriptive format — e.g. `Fix telemetry dashboard alignment` or `Add settings panel layout`.
25+
26+
---
27+
28+
## Starting Work on a Ticket
29+
30+
You can either:
31+
- Create a new ticket to work on, **or**
32+
- Select a **pre-existing ticket** that hasn’t yet been assigned.
33+
34+
1. Open the ticket and click **“Assign yourself”** in the top-right corner so no one else duplicates the work.
35+
36+
2. Drag your ticket into the **“In Progress”** column on the board.
37+
38+
3. Open the ticket again, locate the **Development** section on the right-hand side, and click **“Create a new branch.”**
39+
Then click **“Create Branch.”**
40+
41+
<p align="center">
42+
<img width="1274" height="742" alt="image" src="https://github.com/user-attachments/assets/f938c231-57f9-47d7-9605-71aa5776bf84" />
43+
</p>
44+
45+
4. Copy the suggested Git commands and paste them into your VS Code terminal.
46+
47+
5. Verify that you’re on the correct branch — the branch name appears in the **bottom-left corner** of VS Code.
48+
49+
<p align="center">
50+
<img width="1280" height="809" alt="image" src="https://github.com/user-attachments/assets/3e3f4ba7-ff25-412c-8db9-2c56b3bbb67e" />
51+
</p>
52+
53+
---
54+
55+
## Committing and Pushing Changes
56+
57+
You can commit changes using **VS Code (recommended)** or **Bash**.
58+
59+
### Method 1: VS Code (Recommended)
60+
61+
1. Open the **Source Control** tab on the left-hand side.
62+
2. Right-click the files you want to commit and select **“Stage Changes.”**
63+
Confirm the correct files appear under the *Staged Changes* section.
64+
3. Add a clear commit message describing your changes.
65+
4. Press **Commit**, then click the **arrows in the bottom-left corner** to *Synchronize Changes* (push your commit).
66+
67+
<p align="center">
68+
<img width="1294" height="798" alt="image" src="https://github.com/user-attachments/assets/925c060c-fd4b-4e0f-af9d-bfbcb666ccdc" />
69+
</p>
70+
71+
72+
---
73+
74+
### Method 2: Bash (Terminal)
75+
76+
If you prefer the command line, use the following:
77+
78+
```bash
79+
# Stage all changes
80+
git add .
81+
82+
# Or stage specific files
83+
git add <filename>
84+
85+
# Commit your staged changes with a descriptive message
86+
git commit -m "Description of your work"
87+
88+
# Push your changes to your branch
89+
git push origin <branch name>
90+
```
91+
92+
---
93+
94+
### Merging
95+
Navigate to the ticket again and open a pull request. Wait until the automatic tests are ran and fix any changes suggested by those.
96+
97+
Then, in the top right click reviewers then Copilot (GitHub Pro required). Copilot will then offer a code review, it is strongly suggested you make these changes.
98+
99+
Finally, request the "Avis Code team" as a reviewer, and one of the official code reviewers will look over your work. If they deem it suitable to merge, you will be cleared to merge; alternatively, changes will be suggested which you will make and then request another review.

0 commit comments

Comments
 (0)