-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
473 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
name: Bug Report | ||
description: Report a bug error in the code. | ||
title: "🐞 [Bug]: " | ||
labels: ["bug", "error"] | ||
projects: ["algosup/2024-2025-project-3-quickest-path-team-7"] | ||
assignees: | ||
- Pierre2103 | ||
- HiNett | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
🚨 **Oops! There's a bug in the code.** | ||
Thank you for taking the time to report it. Please provide as much detail as possible so we can fix the issue quickly. 🛠️ | ||
- type: input | ||
id: date | ||
attributes: | ||
label: 📅 Bug Report Date | ||
description: Specify the date when the bug was reported. | ||
placeholder: "YYYY-MM-DD" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: 🐞 Bug Description | ||
description: What happened? What did you expect to happen? | ||
placeholder: Provide a clear and concise description of the problem. | ||
value: "A bug occurred!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: steps | ||
attributes: | ||
label: 🔄 Steps to Reproduce | ||
description: Provide the steps to reproduce the issue. | ||
placeholder: e.g., "1. Do this. 2. Do that. 3. See the error." | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: 📜 Relevant Log Output | ||
description: Paste any relevant log output. This will be formatted as code. | ||
render: shell | ||
- type: dropdown | ||
id: environment | ||
attributes: | ||
label: 🖥️ Environment | ||
description: Provide details about your environment. | ||
options: | ||
- Windows | ||
- macOS | ||
- Linux | ||
- Other | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: 🔢 Version | ||
description: Select the version where the bug occurred. | ||
options: | ||
- v0.0.3 | ||
- v0.0.2 | ||
- v0.0.1 | ||
validations: | ||
required: true | ||
- type: input | ||
id: branch | ||
attributes: | ||
label: 🌿 Branch | ||
description: Enter the branch where the bug occurred. | ||
placeholder: Enter the branch name. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-info | ||
attributes: | ||
label: ℹ️ Additional Information | ||
description: Add any other details or context that could help us resolve the issue. | ||
placeholder: Provide additional details here. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Need help or have questions? | ||
url: https://google.com/ | ||
about: If you're unsure how to proceed, reach out to us here. | ||
|
||
issue_template: | ||
- name: Typography Report | ||
title: "✏️ [Typography]: " | ||
about: "Report a typography error in project documents." | ||
labels: ["documentation", "typography"] | ||
- name: Bug Report | ||
title: "🐞 [Bug]: " | ||
about: "Report a bug error in the code." | ||
labels: ["bug", "error"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
name: Typography Report | ||
description: Report a typography error in project documents. | ||
title: "✏️ [Typography]: " | ||
labels: ["documentation", "typography"] | ||
projects: ["algosup/2024-2025-project-3-quickest-path-team-7"] | ||
assignees: | ||
- Pierre2103 | ||
- HiNett | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
📝 **Thank you for reporting a typography issue!** | ||
Clear and detailed reports help us maintain high-quality project documentation. Please fill in the form below. | ||
- type: input | ||
id: date | ||
attributes: | ||
label: 📅 Report Date | ||
description: Specify the date when this issue was reported. | ||
placeholder: "YYYY-MM-DD" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: document-type | ||
attributes: | ||
label: 📄 Document Type | ||
description: Which document contains the typo? | ||
options: | ||
- Functional Specification | ||
- Technical Specification | ||
- Test Plan | ||
- User Manual | ||
- Other | ||
validations: | ||
required: true | ||
- type: input | ||
id: document-type-other | ||
attributes: | ||
label: 🆕 Other Document Type | ||
description: If "Other," please specify the document type. | ||
placeholder: Enter the document type. | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: document-author | ||
attributes: | ||
label: ✍️ Document Author | ||
description: Who wrote the document? | ||
options: | ||
- Elone DELILLE | ||
- Abderrazaq MAKRAN | ||
- Guillaume DERAMCHI | ||
- Pierre GORIN | ||
- Benoît DE KEYN | ||
- Axel DAVID | ||
- Tino GABET | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: typo-location | ||
attributes: | ||
label: 📌 Typo Location | ||
description: Where exactly is the typo? (Line, section, or paragraph) | ||
placeholder: Provide precise details. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: error | ||
attributes: | ||
label: ❌ Error Description | ||
description: What is the typo? | ||
placeholder: Describe the error. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: correction | ||
attributes: | ||
label: ✅ Suggested Correction | ||
description: What is the suggested correction? | ||
placeholder: Provide the corrected text. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-info | ||
attributes: | ||
label: ℹ️ Additional Information | ||
description: Add any additional details or context that might help us address the issue. | ||
placeholder: Additional details here. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# 🔀 Merge Branches | ||
|
||
## 📅 Merge Date | ||
Specify the date when this merge is being proposed: | ||
<!-- WRITE HERE, IN THIS FORMAT: YYYY-MM-DD --> | ||
|
||
--- | ||
|
||
## 📝 Merge Purpose | ||
What is the purpose of this merge? | ||
<!-- WRITE HERE --> | ||
|
||
--- | ||
|
||
## 🔄 Branch Changes | ||
Summarize the key changes introduced in the branch being merged: | ||
<!-- WRITE HERE --> | ||
|
||
--- | ||
|
||
## ⚠️ Potential Merge Risks | ||
Identify any risks, such as conflicts or regressions, that might arise from this merge: | ||
<!-- WRITE HERE --> | ||
|
||
--- | ||
|
||
## ✅ Merge Checklist | ||
Before proceeding with the merge, ensure the following steps are completed: | ||
<!-- TICK THE BOX WITH "x" TO APPROVE --> | ||
- [ ] 🟢 **Code conflicts have been resolved.** | ||
- [ ] 👀 **Code was reviewed and approved by peers.** | ||
- [ ] ✅ **All tests pass without errors.** | ||
- [ ] 📚 **Documentation is updated, if applicable.** | ||
|
||
|
||
|
||
--- | ||
|
||
## ℹ️ Additional Information | ||
Include any additional notes or follow-up actions needed after the merge: | ||
<!-- WRITE HERE --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Continuous Testing | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
- dev | ||
- qa | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build-and-test: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
with: | ||
submodules: recursive # Fetch Google Test submodule | ||
|
||
- name: Install dependencies | ||
run: sudo apt-get update && sudo apt-get install -y cmake build-essential | ||
|
||
- name: Configure project | ||
run: cmake -S . -B build | ||
|
||
- name: Build project | ||
run: cmake --build build | ||
|
||
- name: Run unit tests | ||
run: cd build && ctest --output-on-failure |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
|
||
.DS_Store | ||
# googletest | ||
build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "googletest"] | ||
path = googletest | ||
url = https://github.com/google/googletest.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
#CMakeLists.txt | ||
cmake_minimum_required(VERSION 3.10) | ||
project(QuickestPathTeam7) | ||
|
||
# Set the C++ standard | ||
set(CMAKE_CXX_STANDARD 11) | ||
|
||
# Include Google Test | ||
add_subdirectory(googletest) | ||
|
||
# Add Hello World executable | ||
add_executable(hello_world code/hello_world.cpp) | ||
|
||
# Add Unit Tests executable | ||
add_executable(unit_tests code/unit_tests.cpp) | ||
target_link_libraries(unit_tests gtest gtest_main) | ||
|
||
# Enable testing | ||
enable_testing() | ||
add_test(NAME UnitTests COMMAND unit_tests) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2025 ALGOSUP | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.