Skip to content

Commit 988744d

Browse files
roxblnfkroxblnfk
authored
Merge pull request #196: ci: fixes in commit linting and new issue templates
2 parents 83720a0 + 7200063 commit 988744d

File tree

10 files changed

+390
-101
lines changed

10 files changed

+390
-101
lines changed

‎.github/.commitlint.config.mjs

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ export default {
1111
ignores: [(commitMessage) => automaticCommitPattern.test(commitMessage)],
1212
rules: {
1313
'body-leading-blank': [1, 'always'],
14-
'body-max-line-length': [2, 'always', 100],
14+
'body-max-line-length': [2, 'always', 120],
1515
'footer-leading-blank': [1, 'always'],
16-
'footer-max-line-length': [2, 'always', 100],
16+
'footer-max-line-length': [2, 'always', 120],
1717
'header-max-length': [2, 'always', 100],
1818
'scope-case': [2, 'always', 'lower-case'],
1919
'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
@@ -25,18 +25,19 @@ export default {
2525
2,
2626
'always',
2727
[
28-
'feat',
29-
'fix',
30-
'perf',
31-
'docs',
32-
'style',
33-
'deps',
34-
'refactor',
35-
'ci',
36-
'test',
37-
'revert',
38-
'build',
39-
'chore',
28+
'feat', // New feature
29+
'fix', // Bug fix
30+
'perf', // Performance improvement
31+
'docs', // Documentation changes
32+
'style', // Code style update (formatting, missing semi colons, etc)
33+
'deps', // Dependency updates
34+
'refactor', // Code refactoring
35+
'ci', // Continuous integration changes
36+
'test', // Adding missing tests
37+
'revert', // Revert to a previous commit
38+
'build', // Changes that affect the build system
39+
'chore', // Other changes that don't modify src or test files
40+
'security', // Security improvements
4041
],
4142
],
4243
},

‎.github/ISSUE_TEMPLATE/1-bug-report.yml

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
3+
name: 🐞 Bug Report
4+
description: Report an issue to help the project improve.
5+
title: '[Bug]: '
6+
labels: ['type: bug', "status:to be verified"]
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: 🐞 **Bug Report**
12+
13+
- type: checkboxes
14+
id: search-done
15+
attributes:
16+
label: No duplicates 🥲.
17+
options:
18+
- label: I have searched for a similar issue in our bug tracker and didn't find any solutions.
19+
required: true
20+
21+
- type: textarea
22+
id: bug-description
23+
attributes:
24+
label: Describe the bug
25+
description: Please provide a clear and detailed description of what the bug is. This helps us understand the issue quickly and look for potential fixes.
26+
placeholder: Explain the bug in as much detail as possible...
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: regression
32+
attributes:
33+
label: Is this a regression?
34+
description: |
35+
Was this functionality working in a previous version?
36+
If yes, please mention the last version in which it worked properly.
37+
Understanding regressions helps prioritize fixes.
38+
placeholder: Yes or No, and details about the last working version...
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
id: steps-to-reproduce
44+
attributes:
45+
label: To Reproduce
46+
description: |
47+
'Please provide step-by-step instructions that reproduce the issue:
48+
1. Use x argument / navigate to...
49+
2. Fill this information...
50+
3. Go to...
51+
4. See error
52+
placeholder: Detailed steps to reproduce the bug...
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: expected-behaviour
58+
attributes:
59+
label: Expected behaviour
60+
description: |
61+
Describe what you expected to happen.
62+
Clear expectations help understand the gap between current and desired states.
63+
placeholder: What did you expect to happen instead of the bug?
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: media
69+
attributes:
70+
label: Media prove
71+
description: If applicable, add screenshots or videos to better illustrate the issue. Visual aids can significantly aid in diagnosing problems quicker.
72+
placeholder: Upload files or paste links here...
73+
validations:
74+
required: false
75+
76+
- type: dropdown
77+
id: database
78+
attributes:
79+
label: Database
80+
description: On which databases does the error appear?
81+
multiple: true
82+
options:
83+
- SQLite
84+
- MySQL
85+
- PostgreSQL
86+
- MSSQL
87+
88+
- type: textarea
89+
id: environment
90+
attributes:
91+
label: Your environment
92+
description: |
93+
Provide detailed information about your environment to help us replicate the issue:
94+
* OS: [e.g. Ubuntu]
95+
* PHP version: [e.g. 8.2.2]
96+
* Package version: [e.g. 1.0.0]
97+
* Any relevant environment details
98+
placeholder: |
99+
- OS: Ubuntu
100+
- PHP version: 8.2.2
101+
- Package version: 2.9.0
102+
- Any relevant environment details...
103+
validations:
104+
required: false
105+
106+
- type: textarea
107+
id: additional-context
108+
attributes:
109+
label: Additional context
110+
description: Include any other context about the problem here, such as unusual system configurations, previous issues, or possible causes.
111+
placeholder: Any additional information that could help us resolve the issue...
112+
validations:
113+
required: false
114+
115+
- type: markdown
116+
attributes:
117+
value: |
118+
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
119+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
120+
- [Code of Conduct](https://github.com/cycle/database/blob/2.x/.github/CODE_OF_CONDUCT.md)
121+
- [Contribution Guidelines](https://github.com/cycle/database/blob/2.x/.github/CONTRIBUTING.md)
122+
123+
Additionally, consider joining our discussions on:
124+
- [Spiral Discord Community](https://discord.gg/spiralphp)
125+
126+
...

‎.github/ISSUE_TEMPLATE/2-feature-request.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
3+
name: 🚀 Feature Request
4+
description: Suggest an idea or possible new feature for this project.
5+
title: '[Feature]: '
6+
labels: ['type: feature']
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: 🚀 **Feature Request**
12+
13+
- type: textarea
14+
id: problem-related
15+
attributes:
16+
label: Is your feature request related to a problem? Please describe.
17+
description: |
18+
Please provide a clear and detailed description of what the problem is.
19+
For example, 'I'm always frustrated when...'.
20+
This will help us understand the context and the impact of the problem.
21+
placeholder: Describe the problem...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: desired-solution
27+
attributes:
28+
label: "Describe the solution you'd like"
29+
description: |
30+
What would you like to see happen? Please provide a detailed explanation of the desired feature.
31+
You may include bullet points to outline objectives, key activities, and expected outcomes.
32+
placeholder: |
33+
1. Objective: [What you hope to achieve with this feature]
34+
2. Key Activities: [Steps to implement the feature]
35+
3. Expected Outcome: [Benefits and results of the feature]
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: alternative-solutions
41+
attributes:
42+
label: "Describe alternatives you've considered"
43+
description: |
44+
Are there alternative solutions or features you've considered? Please describe them.
45+
Understanding different possible solutions can help in finding the best path forward.
46+
placeholder: Describe any alternative solutions or workarounds you have considered...
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: additional-context
52+
attributes:
53+
label: Additional context
54+
description: |
55+
Add any other context or screenshots about the feature request here.
56+
Links to similar features, or visual aids that support your proposal, if applicable.
57+
placeholder: Insert any additional context or links to similar features here...
58+
validations:
59+
required: false
60+
61+
- type: markdown
62+
attributes:
63+
value: |
64+
📛 To ensure a smooth issue processing, please check if a similar feature request has already been submitted before creating a new one.
65+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
66+
- [Code of Conduct](https://github.com/cycle/database/blob/2.x/.github/CODE_OF_CONDUCT.md)
67+
- [Contribution Guidelines](https://github.com/cycle/database/blob/2.x/.github/CONTRIBUTING.md)
68+
69+
Additionally, consider joining our discussions on:
70+
- [Spiral Discord Community](https://discord.gg/spiralphp)
71+
72+
...

‎.github/ISSUE_TEMPLATE/3-docs-bug-report.yml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
3+
name: 📚 Documentation or README.md issue report
4+
description: Report an issue in the project's documentation or README.md file.
5+
title: '[Docs]: '
6+
labels: ['type: documentation', 'type: maintenance']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: 📚 **Documentation Issue Report**
15+
16+
- type: textarea
17+
id: documentation-bug-description
18+
attributes:
19+
label: Describe the bug
20+
description: Provide a clear and concise description of what the error or issue is in the documentation.
21+
placeholder: Explain the issue with the documentation...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: steps-to-reproduce
27+
attributes:
28+
label: To Reproduce
29+
description: |
30+
Please provide steps to reproduce the error in the documentation:
31+
1. Navigate to the section or URL where the error occurs...
32+
2. Specify the misleading or incorrect information...
33+
3. Suggest what is expected if applicable...
34+
placeholder: |
35+
1. URL or Section...
36+
2. Misleading information...
37+
3. Expected correction...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: media-prove
43+
attributes:
44+
label: Media prove
45+
description: If applicable, add screenshots or videos to better illustrate the issue with the documentation.
46+
placeholder: Upload files or paste links here...
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: desired-solution
52+
attributes:
53+
label: Describe the solution you would like
54+
description: Describe what changes or improvements you would like to see in the documentation.
55+
placeholder: Describe the desired changes or improvements...
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: additional-context
61+
attributes:
62+
label: Additional context
63+
description: Add any other context or additional information that could help clarify the documentation issue.
64+
placeholder: Provide any additional context here...
65+
validations:
66+
required: false
67+
68+
- type: markdown
69+
attributes:
70+
value: |
71+
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
72+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
73+
- [Code of Conduct](https://github.com/cycle/database/blob/2.x/.github/CODE_OF_CONDUCT.md)
74+
- [Contribution Guidelines](https://github.com/cycle/database/blob/2.x/.github/CONTRIBUTING.md)
75+
76+
Additionally, consider joining our discussions on:
77+
- [Spiral Discord Community](https://discord.gg/spiralphp)
78+
79+
...

‎.github/ISSUE_TEMPLATE/4-security-report.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
3+
name: ⚠️ Security Report
4+
description: Please report security issues directly through GitHub Security Advisories to ensure privacy.
5+
title: '[Security]: '
6+
labels: ['type: bug', 'priority: high', 'type: security']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: >
15+
⚠️ **Please DO NOT report security vulnerabilities here.** Instead, use the GitHub Security Advisories feature to report them privately and securely. This helps us address issues responsibly without exposing them publicly.
16+
17+
- type: markdown
18+
attributes:
19+
value: >
20+
GitHub Advisories do not automatically notify maintainers, so by using the advisories, you help maintain confidentiality while ensuring the issue is documented and tracked properly.
21+
22+
- type: markdown
23+
attributes:
24+
value: 'To create a new advisory, go to: [Create Security Advisory](https://github.com/cycle/database/security/advisories/new)'
25+
26+
- type: textarea
27+
id: github-advisory-url
28+
attributes:
29+
label: Your GitHub Advisory URL
30+
description: Optionally, you can paste the URL of the GitHub Security Advisory you have created here for reference.
31+
placeholder: Paste the GitHub Security Advisory URL here...
32+
validations:
33+
required: false
34+
35+
...

0 commit comments

Comments
 (0)