Skip to content

Commit 985f26b

Browse files
authoredApr 4, 2024··
Merge pull request #3546 from msupply-foundation/release-1.7
Release 1.7
2 parents 835b11b + 3725fa6 commit 985f26b

File tree

781 files changed

+15887
-6089
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

781 files changed

+15887
-6089
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ assignees: ''
1212

1313
## Expected behaviour 🤔
1414

15-
1615
## How to Reproduce 🔨
1716

1817
Steps to reproduce the behaviour:
@@ -24,11 +23,9 @@ Steps to reproduce the behaviour:
2423

2524
## Your environment 🌱
2625
<!-- e.g. 1.2.3 -->
27-
- Version:
28-
- Platform:
29-
- [ ] android (tablet)
30-
- [ ] browser (extra points if you tell us which one)
31-
- [ ] desktop (windows)
32-
- [ ] desktop (macOS)
33-
- [ ] server (windows)
34-
26+
- Version:
27+
- mSupply version:
28+
<!-- e.g. android, browser (extra points if you tell us which one), desktop (windows), desktop (macOS), server (windows) -->
29+
- Platform:
30+
<!-- PostgreSQL or SQLite3 -->
31+
- Database type:

‎.github/ISSUE_TEMPLATE/refactor.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
name: Refactor Suggestion
3+
about: Suggest a refactor
4+
title: ""
5+
labels: "refactor, needs triage"
6+
assignees: ""
7+
---
8+
9+
## The suggestion
10+
11+
<!-- Provide a clear and concise description of the suggested change E.g. "Add a new helper function to avoid the need to create service providers in test cases", "Upgrade diesel version to allow async database access", "Create a rust macro to automatically map Graphql and Service layer enums". -->
12+
13+
## Example use case
14+
15+
<!-- EXAMPLE:
16+
We have a lot of enum mapping code that looks like this:
17+
18+
```rust
19+
impl ActivityLogNodeType {
20+
pub fn from_domain(from: &ActivityLogType) -> ActivityLogNodeType {
21+
use ActivityLogNodeType as to;
22+
use ActivityLogType as from;
23+
24+
match from {
25+
from::UserLoggedIn => to::UserLoggedIn,
26+
from::InvoiceCreated => to::InvoiceCreated,
27+
...
28+
from::SensorLocationChanged => to::SensorLocationChanged,
29+
}
30+
}
31+
32+
```
33+
34+
To avoid needing to update this every time we add a new variant to the `ActivityLogType` enum, we could create a macro that automatically maps the variants of the `ActivityLogType` enum to the variants of the `ActivityLogNodeType` enum. This would allow us to write the above code like this:
35+
36+
```rust
37+
impl ActivityLogNodeType {
38+
map_std_enum!(ActivityLogType, ActivityLogNodeType);
39+
}
40+
```
41+
-->
42+
43+
### Why should we invest time in this?
44+
45+
<!-- Describe the benefits of this change.
46+
Examples:
47+
"This makes it faster and less annoying to add new activity log types, which is a common activity, I estimate that this will save us 1 hour per month."
48+
"This change makes the code easier to test, reducing the risk of introducing bugs in the future."
49+
"This change will make it easier for new developers to understand the codebase, reducing the time it takes to onboard new developers."
50+
"Code will run faster, reducing the time it takes to run our test suite."
51+
-->
52+
53+
### Are there any risks associated with this change?
54+
55+
<!-- highlight any risks the code changes might introduce
56+
Examples:
57+
"The change would involve rewriting our login infrastructure, we'll need extra testing around the login process, and review all our permission mappings"
58+
"This change is low risk, as we expect it's functionality to be covered by existing tests and these tests don't need to change"
59+
"This change might impact frontend code that won't be covered by our existing tests, we'll need to do a full regression test with QA team"
60+
"Introducing async database access might uncover new race conditions or bugs that our test cases don't currently cover"
61+
-->
62+
63+
### How much effort is required?
64+
65+
<!-- Estimate the amount of effort required to implement this change -->
66+
<!--
67+
Examples:
68+
"This change is trivial, it will take less than 1 hour to implement."
69+
"This change is a lot of work potentially weeks of effort, however it will reduce the overall time needed to implement our current task, and will make future tasks easier."
70+
"This change is a lot of work potentially weeks of effort, however once the pattern is established, we can do the refactor piece by piece as we have time available."
71+
-->
72+
73+
### Agreed Solution
74+
75+
<!-- Describe how you expect to do the refactor, this might be updated as the team discusses the approach more fully -->

0 commit comments

Comments
 (0)
Please sign in to comment.