You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A clear and concise description of what the bug is.
12
+
Thank you for contributing to the Luos project!
15
13
16
-
**Network configuration**
17
-
- Add the routing table or list the nodes and their services
18
-
- Power input configuration
14
+
Before to begin, please ensure that this bug is an actual bug, and that it has not been reported yet (you can use the GitHub searchbar with keywords to look for other issues).
19
15
20
-
**How to reproduce the bug**
21
-
Describe thoroughly the steps to reproduce the bug.
16
+
If you only have a usage question, ask it to the [Luos Community](https://discord.gg/luos).
22
17
23
-
**Additional context**
24
-
Add any other context about the problem here.
25
-
Don't hesitate to add screenshots or to link an entry from the forum.
18
+
At last, feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos!
19
+
20
+
## Details
21
+
Please replace the italic test by your inputs and details in each of the following sections:
22
+
23
+
### Which version the bug has been detected on
24
+
*Luos engine X.Y.Z*
25
+
26
+
### Description of the bug
27
+
*A clear and concise description of what is the expected behavior and what is the current behavior.*
28
+
29
+
### Context and environment
30
+
-*Add the routing table or the list of the nodes and their services*
31
+
-*Detail the power input configuration*
32
+
-*Add any other details about the context and environment*
33
+
34
+
### How to reproduce the bug
35
+
*Describe thoroughly the steps to reproduce the bug.*
36
+
37
+
### Possible solution
38
+
*Give the details of a possible solution to resolve the bug.*
39
+
40
+
Thank you! Your issue will be reviewed by our admins.
Copy file name to clipboardexpand all lines: .github/ISSUE_TEMPLATE/feature-request.md
+24-2
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,30 @@ name: Feature request
3
3
about: Suggest a new feature to be working in Luos
4
4
title: "[NEW FEATURE] "
5
5
labels: feature
6
-
assignees: nicolas-rabault
6
+
assignees: simonbdy
7
7
8
8
---
9
9
10
-
**What feature would you like to be included in Luos?**
10
+
## Before to begin
11
+
12
+
Thank you for contributing to the Luos project!
13
+
14
+
Before to begin, please ensure that the feature you are requesting doesn't exist yet (you can use the GitHub searchbar with keywords to look for other issues).
15
+
16
+
If you only have a usage question, ask it to the [Luos Community](https://discord.gg/luos).
17
+
18
+
At last, feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos!
19
+
20
+
## Details
21
+
Please replace the italic test by your inputs and details in each of the following sections:
22
+
23
+
### What feature would you like to be included in Luos?
24
+
*Describe the feature you want to be added to Luos.*
25
+
26
+
### Describe the expected behavior of the feature
27
+
*Describe how the feature would work, in which environment and context.*
28
+
29
+
### What is the motivation / use case for changing the behavior?
30
+
*Explain why you request this feature, and in which use case it applies.*
31
+
32
+
Thank you! Your issue will be reviewed by our admins.
Copy file name to clipboardexpand all lines: .github/ISSUE_TEMPLATE/porting-request.md
+28-13
Original file line number
Diff line number
Diff line change
@@ -3,25 +3,40 @@ name: Porting request
3
3
about: Suggest a new MCU to be compatible with Luos
4
4
title: "[MCU PORTING] "
5
5
labels: porting
6
-
assignees: nicolas-rabault
6
+
assignees: simonbdy
7
7
8
8
---
9
9
10
-
**What MCU would you like Luos to be compatible with?**
10
+
## Before to begin
11
11
12
-
**Link the datasheet of this MCU:**
12
+
Thank you for contributing to the Luos project!
13
13
14
-
**Describe your project:**
14
+
Before to begin, please ensure that the issue you want to open doesn't exist yet with the same porting request (you can use the GitHub searchbar with keywords to look for other issues).
15
15
16
-
**Describe the electronic board hosting the MCU:**
17
-
Add details about the network interface, the pins used, the device, etc.
18
-
Don't hesitate to post a schematic.
16
+
If you only have a usage question, ask it to the [Luos Community](https://discord.gg/luos).
19
17
20
-
**Ensure that every box bellow is checked:**
21
-
-[ ] The MCU is not in the [compatible list](https://www.luos.io/docs/next/compatibility/mcu_demoboard) in the documentation.
18
+
At last, feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos!
19
+
20
+
## Details
21
+
Please replace the italic test by your inputs and details in each of the following sections:
22
+
23
+
### What MCU would you like Luos to be compatible with?
24
+
*List the MCU(s) you want Luos to be compatible with.*
25
+
26
+
### Link the datasheet of this MCU
27
+
*Please provide the links of the MCU's datasheet.*
28
+
29
+
### Describe your project
30
+
*Describe your project and explain why you need the MCU(s) to be Luos compatible.*
31
+
32
+
### Describe the electronic board hosting the MCU
33
+
*Add details about the network interface, the pins used, the device, etc. Don't hesitate to post a schematic.*
34
+
35
+
### Ensure that every box bellow is checked
36
+
-[ ] The MCU is not in the [compatible list](https://www.luos.io/docs/compatibility/mcu_demoboard) in the documentation.
22
37
-[ ] The MCU is not already in an existing [porting issue](https://github.com/Luos-io/luos_engine/issues).
23
-
-[x] The issue has the label `porting`.
24
-
-[ ] The issue is added to the [Porting](https://github.com/orgs/Luos-io/projects/3) project.
25
38
26
-
**Additional context**
27
-
Add any other context about the porting request here.
39
+
### Additional context
40
+
*Add any other context about the porting request here.*
41
+
42
+
Thank you! Your issue will be reviewed by our admins.
Copy file name to clipboardexpand all lines: .github/pull_request_template.md
+37-11
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,50 @@
1
-
# PR Checklist
1
+
By submiting this PR, you agree with the associated license ([Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) or [MIT](http://choosealicense.com/licenses/mit/)) and with our [Contributor License Agreement](https://github.com/Luos-io/luos_engine/) (CLA).
2
2
3
-
### _1- PR Comments_
4
-
*If needed, to be filled by developer*
3
+
## Before to begin
5
4
6
-
<br><hr/>
7
-
*WARNING : Do not edit the checklist below.*
8
-
<hr/><br>
5
+
Thank you for contributing to the Luos project!
9
6
10
-
### _2- Developer section_
7
+
Before to begin, please follow these steps:
8
+
9
+
-[ ] Ensure that this PR is not a duplicate.
10
+
-[ ] Assign @Simonbdy to this PR
11
+
-[ ] Add the PR to the `Luos contribution project`
12
+
13
+
Feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos.
14
+
15
+
## PR Description section
16
+
17
+
### Description and dependencies
18
+
*Please include here a summary of the changes and the related issue. List any dependencies that are required for this change.*
19
+
20
+
### Changes
21
+
Please choose the relevant options:
22
+
23
+
-[ ] Bug fix (non-breaking change which fixes an issue)
24
+
-[ ] New feature (non-breaking change which adds functionality)
25
+
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
26
+
-[ ] This change requires a documentation update
27
+
28
+
### Related issue(s)
29
+
*Provide a list of the related issues that will be fixed by this PR.*
30
+
31
+
---
32
+
33
+
**WARNING**: Do not edit the checklist below.
34
+
35
+
---
36
+
37
+
## Developer section
11
38
12
39
-[ ][Documentation] is up to date with new feature
13
-
-[ ][Tests] are *passed OK* (Non regression, new features & bug fixes)
14
-
-[ ][Code Quality]Remind to check if:
40
+
-[ ][Tests] are *passed OK* (non regression, new features & bug fixes)
41
+
-[ ][Code Quality]please check if:
15
42
* Each function has a header (description, inputs, outputs)
16
43
* Code is commented (particularly in hard to understand areas)
17
44
* There are no new warnings that can be corrected
18
45
* Commits policy is respected (constitancy commits, clear commits comments)
19
-
<hr/><br>
20
46
21
-
### _3- QA section_
47
+
##QA section
22
48
23
49
-[ ][Review] tests for new features have been *reviewed*
0 commit comments