Skip to content

Commit ace3df3

Browse files
tuxthebottuxthebot
committed
chore(templates): enhance GitHub issue and PR templates
- Standardize and improve all issue templates for better contributor experience - Add comprehensive security report template with responsible disclosure guidelines - Update CODEOWNERS with proper team assignments - Enhance pull request template with structured sections - Move documentation files to root for better visibility - Configure repository settings with branch protection rules Security: Add security reporting template and guidelines Refactor: Reorganize template files for better maintainability Docs: Update all templates with consistent formatting and instructions This commit follows the Conventional Commits specification and includes: - Type: chore (maintenance changes) - Scope: templates (affects template files) - Subject: Brief description - Body: Detailed explanation of changes - Footer: Additional metadata and references
1 parent bcfd855 commit ace3df3

14 files changed

Lines changed: 552 additions & 374 deletions

‎.github/CODEOWNERS‎

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
1-
# These owners will be the default owners for everything in
2-
# the repo. Unless a later match takes precedence,
3-
# @Josee9988 will be requested for
4-
# review when someone opens a pull request.
5-
# if you want to add more owners, just write it after @Josee9988
1+
# Default owners for the entire repository
2+
# These users will be requested for review on all pull requests
63
* @TuxTechLab
4+
5+
# Documentation
6+
# All markdown files in the root and docs directory
7+
/*.md @TuxTechLab/docs
8+
/.github/ @TuxTechLab/team-core @TuxTechLab/team-docs
9+
/docs/ @TuxTechLab/team-docs
10+
11+
# Source code
12+
# Core application code and configuration
13+
/src/ @TuxTechLab/team-core @TuxTechLab/team-backend
14+
/public/ @TuxTechLab/team-core @TuxTechLab/team-frontend
15+
/package.json @TuxTechLab/team-core @TuxTechLab/team-devops
16+
17+
# Configuration files
18+
# Important configuration files that require core team review
19+
/*.json @TuxTechLab/team-core
20+
/*.yaml @TuxTechLab/team-core
21+
/*.yml @TuxTechLab/team-core
22+
23+
# Tests
24+
/tests/ @TuxTechLab/team-qa @TuxTechLab/team-core
25+
26+
# CI/CD
27+
/.github/workflows/ @TuxTechLab/team-devops @TuxTechLab/team-core
28+
29+
# Security
30+
SECURITY.md @TuxTechLab/security
31+
32+
# How to add more rules:
33+
# - Each line is a file pattern followed by one or more owners
34+
# - The last matching pattern has the most precedence
35+
# - Use @username or @org/team-name
36+
# - Example: /path/to/file.js @user1 @user2 @org/team
37+
# - Example: *.js @frontend-team

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

Lines changed: 32 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,51 +3,47 @@ name: "🐞 Bug Report"
33
about: "Report an issue to help the project improve."
44
title: "[Bug] "
55
labels: "Type: Bug"
6-
assignees: Tux
7-
6+
assignees:
7+
- Tux
88
---
99

10-
# **🐞 Bug Report**
10+
# 🐞 Bug Report
1111

12-
## **Describe the bug**
12+
## 📋 Description
1313
<!-- A clear and concise description of what the bug is. -->
1414

15-
*
16-
17-
---
18-
19-
### **Is this a regression?**
20-
<!-- Did this behaviour used to work in the previous version? -->
21-
<!-- Yes, the last version in which this bug was not present was: ... -->
22-
23-
---
24-
25-
### **To Reproduce**
26-
27-
<!-- Steps to reproduce the error:
28-
(e.g.:)
29-
1. Use x argument / navigate to
30-
2. Fill this information
31-
3. Go to...
32-
4. See error -->
33-
34-
<!-- Write the steps here (add or remove as many steps as needed)-->
35-
36-
1.
37-
2.
38-
3.
39-
4.
40-
41-
---
42-
43-
### **Expected behaviour**
15+
## 🔍 Steps to Reproduce
16+
<!--
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
-->
22+
1.
23+
2.
24+
3.
25+
4.
26+
27+
## 🎯 Expected Behavior
4428
<!-- A clear and concise description of what you expected to happen. -->
4529

46-
*
30+
## 📸 Screenshots / Screen Recordings
31+
<!-- If applicable, add screenshots or screen recordings to help explain your problem. -->
4732

48-
---
33+
## 🌍 Environment
34+
**Device:** <!-- e.g., Desktop, Laptop, Mobile -->
35+
**OS:** <!-- e.g., Windows 11, macOS 13, Ubuntu 22.04 -->
36+
**Browser:** <!-- e.g., Chrome 115, Firefox 114, Safari 16 -->
37+
**Version:** <!-- e.g., 1.0.0 -->
38+
39+
## 🔄 Is this a regression?
40+
<!-- Did this work in previous versions? -->
41+
- [ ] Yes, it worked in version: `...`
42+
- [ ] No, it never worked
43+
- [ ] I don't know
4944

50-
### **Media prove**
45+
## 📝 Additional Context
46+
<!-- Add any other context about the problem here. -->
5147
<!-- If applicable, add screenshots or videos to help explain your problem. -->
5248

5349
---

‎.github/ISSUE_TEMPLATE/2-failing-test.md‎

Lines changed: 64 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,81 @@
11
---
22
name: "💉 Failing Test"
3-
about: "Report failing tests or CI jobs."
4-
title: "[Test] "
5-
labels: "Type: Test"
6-
assignees: Tux
7-
3+
about: Report failing tests, CI/CD pipeline jobs, or test suite issues
4+
title: "[TEST] "
5+
labels: "Type: Test", "Needs Triage"
6+
assignees: "@TuxTechLab/team-qa", "@TuxTechLab/team-devops"
87
---
98

10-
# **💉 Failing Test**
9+
# 🚨 Failing Test Report
1110

12-
## **Which jobs/test(s) are failing**
13-
<!-- The CI jobs or tests that are failing -->
11+
> ⚠️ **Before You Begin**
12+
> - Search existing issues to avoid duplicates
13+
> - Check if this is a known issue in our [status page](https://status.tuxtechlab.com)
14+
> - Ensure you're using the latest version of the codebase
1415
15-
*
16+
## 📋 Basic Information
1617

17-
---
18+
- **Test/Job Name**:
19+
- **Test File/Path**:
20+
- **Branch/Commit**:
21+
- **CI/CD Environment**: [e.g., GitHub Actions, Jenkins, CircleCI]
22+
- **Run ID/URL**:
23+
- **First Observed**: [Date and time]
24+
- **Frequency**: [Always/Intermittent/Specific conditions]
1825

19-
## **Reason for failure/description**
20-
<!-- Try to describe why the test is failing or what we are missing to make it pass. -->
26+
## 🔍 Detailed Description
2127

22-
---
28+
### Expected Behavior
29+
<!-- What should have happened? -->
2330

24-
### **Media prove**
25-
<!-- If applicable, add screenshots or videos to help explain your problem. -->
31+
### Actual Behavior
32+
<!-- What actually happened? -->
2633

27-
---
34+
### Error Message/Logs
35+
```
36+
Paste relevant error messages or logs here
37+
```
38+
39+
## 🔧 Steps to Reproduce
40+
1.
41+
2.
42+
3.
2843

29-
### **Additional context**
30-
<!-- Add any other context or additional information about the problem here. -->
44+
## 📸 Screenshots/Logs
45+
<!--
46+
To attach screenshots:
47+
1. Drag and drop images here or
48+
2. Use this markdown:
49+
```markdown
50+
![Description](https://.../screenshot.png)
51+
```
52+
-->
3153

32-
*
54+
## 🌍 Environment
55+
- **OS**: [e.g., Windows 10, Ubuntu 20.04, macOS 12]
56+
- **Browser**: [if applicable, e.g., Chrome 98, Firefox 97]
57+
- **Node.js Version**: [if applicable]
58+
- **Dependencies**: [any relevant dependency versions]
3359

34-
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
60+
## 🔄 Related Issues/PRs
61+
<!-- List any related issues or pull requests -->
62+
-
63+
## 📝 Additional Context
64+
<!-- Any other context about the problem -->
3565

36-
Oh, hi there! 😄
66+
## ✅ Checklist
67+
- [ ] I've searched for similar issues
68+
- [ ] I've included all relevant information
69+
- [ ] I've attached necessary screenshots/logs
70+
- [ ] I've tested with the latest code
3771

38-
To expedite issue processing, please search open and closed issues before submitting a new one.
39-
Please read our Rules of Conduct at this repository's `.github/CODE_OF_CONDUCT.md`
72+
<!--
73+
📌 NOTE:
74+
- For security-sensitive test failures, please email security@tuxtechlab.com
75+
- Include the [SECURITY] prefix in the title for critical test failures
76+
- @mention relevant team members if you know who should handle this
77+
-->
4078

41-
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
79+
<!-- Auto-closing keywords (remove if not needed) -->
80+
/kind test-failure
81+
/priority needs-triage

‎.github/ISSUE_TEMPLATE/3-docs-bug.md‎

Lines changed: 64 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,64 @@
1-
---
2-
name: "📚 Documentation or README.md issue report"
3-
about: "Report an issue in the project's documentation or README.md file."
4-
title: ""
5-
labels: "Documentation"
6-
assignees: Tux
7-
8-
---
9-
# **📚 Documentation Issue Report**
10-
11-
## **Describe the bug**
12-
<!-- A clear and concise description of what the bug is. -->
13-
14-
*
15-
16-
---
17-
18-
### **To Reproduce**
19-
20-
<!-- Steps to reproduce the error:
21-
(e.g.:)
22-
1. Use x argument / navigate to
23-
2. Fill this information
24-
3. Go to...
25-
4. See error -->
26-
27-
<!-- Write the steps here (add or remove as many steps as needed)-->
28-
29-
1.
30-
2.
31-
3.
32-
4.
33-
34-
---
35-
36-
### **Media prove**
37-
<!-- If applicable, add screenshots or videos to help explain your problem. -->
38-
39-
---
40-
41-
## **Describe the solution you'd like**
42-
<!-- A clear and concise description of what you want to happen. -->
43-
44-
*
45-
46-
---
47-
48-
### **Additional context**
49-
<!-- Add any other context or additional information about the problem here.-->
50-
51-
*
52-
53-
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
54-
55-
Oh, hi there! 😄
56-
57-
To expedite issue processing, please search open and closed issues before submitting a new one.
58-
Please read our Rules of Conduct at this repository's `.github/CODE_OF_CONDUCT.md`
59-
60-
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
1+
---
2+
name: "📝 Documentation Issue"
3+
about: "Report an issue related to documentation"
4+
title: "[Docs] "
5+
labels:
6+
- "Type: Documentation"
7+
- "Needs Triage"
8+
assignees:
9+
- Tux
10+
---
11+
12+
# 📝 Documentation Issue
13+
14+
## 🎯 Description
15+
<!-- A clear and concise description of the documentation issue. -->
16+
17+
## 📍 Location
18+
<!-- Where is this documentation issue located? -->
19+
- **Page/File**:
20+
- **Section**:
21+
- **URL** (if applicable):
22+
23+
## 🔍 Current Behavior
24+
<!-- Describe what is currently documented that is incorrect or unclear. -->
25+
26+
## ✅ Expected Behavior
27+
<!-- Describe what you expected to see in the documentation. -->
28+
29+
## 📸 Screenshots
30+
<!-- Add screenshots to help explain the issue if applicable. -->
31+
<!-- You can drag and drop images here or provide links to external resources. -->
32+
33+
## 📚 Suggested Changes
34+
<!-- If you have suggestions for how to fix the documentation, please describe them here. -->
35+
36+
## 🔗 Related Issues/Documents
37+
<!-- List any related issues or documents that might help resolve this. -->
38+
39+
## 🌐 Environment
40+
- **Documentation Version**: <!-- e.g., 1.0.0, main branch -->
41+
- **Browser**: <!-- e.g., Chrome 115, Firefox 114 -->
42+
- **Device**: <!-- e.g., Desktop, Mobile -->
43+
- **OS**: <!-- e.g., Windows 11, macOS 13, Ubuntu 22.04 -->
44+
45+
## 📋 Additional Context
46+
<!-- Add any other context about the documentation issue here. -->
47+
48+
## 🏷️ Labels
49+
<!-- Add any relevant labels -->
50+
- [ ] Typo
51+
- [ ] Outdated Information
52+
- [ ] Missing Information
53+
- [ ] Incorrect Example
54+
- [ ] Needs Restructuring
55+
- [ ] Translation Issue
56+
57+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
58+
59+
Oh, hi there! 😄
60+
61+
To expedite issue processing, please search open and closed issues before submitting a new one.
62+
Please read our Rules of Conduct at this repository's `.github/CODE_OF_CONDUCT.md`
63+
64+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->

0 commit comments

Comments
 (0)