beavuck-time 2.4.12 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CONTRIBUTING.md +23 -41
  2. package/openapi/swagger.json +1 -1
  3. package/package.json +5 -5
package/CONTRIBUTING.md CHANGED
@@ -1,57 +1,39 @@
1
1
  # ⏲️ Beavuck Time
2
2
 
3
- Thank you for considering contributing to Beavuck Time!
3
+ Thanks for contributing!
4
4
 
5
- ## 🈸 Opening issues
5
+ ## 🈸 Issues
6
6
 
7
- When you open an issue (be it a bug, a suggestion, or other), please follow the relevant guidelines, so that we can
8
- help you as quickly as possible.
7
+ Use the templates when opening issues:
9
8
 
10
- Any open issues that do not follow the guidelines may be closed immediately.
9
+ - 🐞 [Bug report](https://gitlab.com/beavuck-services/time/-/issues/new?issuable_template=bug)
10
+ - 💡 [Enhancement request](https://gitlab.com/beavuck-services/time/-/issues/new?issuable_template=enhancement)
11
11
 
12
- ### 🐞 Bug reports
12
+ ## 🔀 Merge requests
13
13
 
14
- Please just follow this link where we set it all up for you: [🐞 Create a bug report](https://gitlab.com/beavuck-services/time/-/issues/new?issuable_template=bug)
14
+ If you hate TDD, this might not be the project for you.
15
15
 
16
- Or, to do it by hand : please choose the `bug` issue template when creating the issue, and follow it.
16
+ ### Commit style
17
17
 
18
- ### 💡 Suggestions, enhancement requests, etc.
18
+ **Format:** `emoji Action that you did`
19
19
 
20
- Please just follow this link where we set it all up for you: [💡 Create an enhancement request](https://gitlab.com/beavuck-services/time/-/issues/new?issuable_template=enhancement)
20
+ **Example:** `✏️ Fix typo in README`
21
21
 
22
- Or, to do it by hand : please choose the `enhancement` issue template when creating the issue, and follow it.
22
+ Rules:
23
+ - Short, imperative tense
24
+ - Start with relevant emoji
25
+ - Capitalize first word
26
+ - No period at the end
23
27
 
24
- ## 🔀 Preparing for merge requests
28
+ ### TDD workflow
25
29
 
26
- If you have something against TDD, now is probably the time to turn back.
30
+ 1. **First commit:** Failing tests that demonstrate the bug/feature
31
+ 2. **Second commit:** Code that makes tests pass
27
32
 
28
- You're still there! Thank you.
33
+ All pre-existing tests must still pass.
29
34
 
30
- When you open a merge request, please make sure to follow the relevant steps, so that it can be reviewed and merged as
31
- quickly as possible.
35
+ ### Templates
32
36
 
33
- Any open merge requests that do not follow the guidelines may be closed immediately.
34
-
35
- **All merge requests**
36
-
37
- - **Commits**:
38
- - Your MR will need to be separated into digestible, _logical commits_, with a clear message for each. To fit
39
- with this project's conventions, a _commit message's style_ should be short, in the imperative, start with a relevant emoji,
40
- have its first word be capitalized, and not end with a period. For example: `✏️ Fix typo in README`.
41
- - Your MR will need to follow TDD principles:
42
- - _First, commit failing tests_ targeting the bug or enhancement in question.
43
- - Then, commit the code that does the thing -- the previously failing tests should now pass. (The pre-existing tests
44
- should also still pass, obviously.)
45
- - **Title**: Should be treated like a very important commit message, since it will appear as a commit message on the
46
- `main` branch. See sub-parts below for specific guidelines.
47
- - **Template**: Choose the relevant template (see sub-parts below), then follow the instructions within said template.
48
-
49
- ### 🐛 Bug fixes
50
-
51
- - **Title**: Should follow the convention `🐛 Fix #{{issue_number}}: {{very_short_description_in_the_imperative}}`
52
- - **Description (Template)**: Please choose the `bug_fix` MR template when creating the MR.
53
-
54
- ### ✨ Enhancements, new features, etc.
55
-
56
- - **Title**: `✨ Add #{{issue_number}}: {{very_short_description_in_the_imperative}}`
57
- - **Description (Template)**: Please choose the `enhancement` MR template when creating the MR.
37
+ Pick the right template when creating your MR:
38
+ - `bug_fix` for fixes
39
+ - `enhancement` for new features
package/openapi/swagger.json CHANGED
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "info": {
34
34
  "title": "beavuck-time",
35
- "version": "2.4.12",
35
+ "version": "2.5.1",
36
36
  "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
37
37
  "license": {
38
38
  "name": "Unlicense"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "beavuck-time",
3
- "version": "2.4.12",
3
+ "version": "2.5.1",
4
4
  "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
5
5
  "keywords": [
6
6
  "time",
@@ -64,19 +64,19 @@
64
64
  "@types/cors": "^2.8.19",
65
65
  "@types/express": "^5.0.6",
66
66
  "@types/jest": "^30.0.0",
67
- "@types/node": "^25.0.3",
67
+ "@types/node": "^25.0.5",
68
68
  "@types/supertest": "^6.0.3",
69
69
  "eslint": "^9.39.2",
70
70
  "globals": "^17.0.0",
71
71
  "jest": "^30.2.0",
72
72
  "nodemon": "^3.1.11",
73
- "npm-check-updates": "^19.2.1",
73
+ "npm-check-updates": "^19.3.1",
74
74
  "prettier": "3.7.4",
75
- "supertest": "^7.1.4",
75
+ "supertest": "^7.2.2",
76
76
  "ts-jest": "^29.4.6",
77
77
  "ts-node": "^10.9.2",
78
78
  "typescript": "^5.9.3",
79
- "typescript-eslint": "^8.51.0"
79
+ "typescript-eslint": "^8.52.0"
80
80
  },
81
81
  "engines": {
82
82
  "node": ">=18.20.8"