Skip to content

Commit 6b1095a

Browse files
badhopeHumanOS Team
andcommitted
docs: comprehensive documentation and project standardization
- Complete README.md with badges, features, and detailed sections - Add README_EN.md for English documentation - Create CHANGELOG.md following Keep a Changelog format - Add CODE_OF_CONDUCT.md based on Contributor Covenant - Create SECURITY.md with vulnerability reporting guidelines - Update package.json with keywords, author info, and scripts - Add GitHub issue templates (bug report, feature request, documentation) - Add pull request template - Update Dashboard page with new animation components Co-authored-by: HumanOS Team <[email protected]>
1 parent 004561e commit 6b1095a

31 files changed

Lines changed: 4342 additions & 1415 deletions
Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
1+
---
12
name: Bug Report
2-
description: Report a bug to help us improve
3-
title: '[BUG] '
4-
labels: ['bug', 'needs triage']
3+
description: Report a bug to help us improve HumanOS
4+
title: '[Bug]: '
5+
labels: ['bug', 'needs-triage']
56
assignees: []
67
body:
78
- type: markdown
89
attributes:
910
value: |
10-
## 🐛 Bug Report
11-
12-
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue.
11+
Thanks for taking the time to fill out this bug report! Please fill out the sections below to help us fix the issue.
12+
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: I have searched for existing issues that match this bug
19+
required: true
20+
- label: I am using the latest version of HumanOS
21+
required: true
22+
- label: I have read the [Contributing Guide](../CONTRIBUTING.md)
23+
required: false
1324

1425
- type: textarea
1526
id: description
1627
attributes:
1728
label: Bug Description
1829
description: A clear and concise description of what the bug is
19-
placeholder: Describe the bug here...
30+
placeholder: 'When I click on...'
2031
validations:
2132
required: true
2233

@@ -37,26 +48,46 @@ body:
3748
id: expected
3849
attributes:
3950
label: Expected Behavior
40-
description: What you expected to happen
41-
placeholder: Expected behavior...
51+
description: A clear and concise description of what you expected to happen
52+
placeholder: 'I expected that...'
4253
validations:
4354
required: true
4455

4556
- type: textarea
4657
id: actual
4758
attributes:
4859
label: Actual Behavior
49-
description: What actually happened
50-
placeholder: Actual behavior...
60+
description: A clear and concise description of what actually happened
61+
placeholder: 'Instead, what happened was...'
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: screenshots
67+
attributes:
68+
label: Screenshots
69+
description: If applicable, add screenshots to help explain your problem
70+
placeholder: 'Drag and drop screenshots here'
71+
72+
- type: dropdown
73+
id: severity
74+
attributes:
75+
label: Severity
76+
description: How severe is this bug?
77+
options:
78+
- Low - Minor inconvenience
79+
- Medium - Affects functionality
80+
- High - Major feature broken
81+
- Critical - App is unusable
5182
validations:
5283
required: true
5384

5485
- type: input
5586
id: browser
5687
attributes:
57-
label: Browser and Version
58-
description: Which browser did you use?
59-
placeholder: "e.g., Chrome 120.0, Firefox 121.0"
88+
label: Browser
89+
description: What browser are you using?
90+
placeholder: 'Chrome 120.0.0'
6091
validations:
6192
required: true
6293

@@ -65,28 +96,21 @@ body:
6596
attributes:
6697
label: Operating System
6798
description: What operating system are you using?
68-
placeholder: "e.g., Windows 11, macOS 14.2, iOS 17"
69-
70-
- type: textarea
71-
id: screenshots
72-
attributes:
73-
label: Screenshots
74-
description: If applicable, add screenshots to help explain the bug
75-
placeholder: Drag and drop or paste image here
99+
placeholder: 'Windows 11, macOS 14, Ubuntu 22.04'
100+
validations:
101+
required: true
76102

77103
- type: textarea
78-
id: context
104+
id: additional
79105
attributes:
80106
label: Additional Context
81107
description: Add any other context about the problem here
82-
placeholder: Additional context...
108+
placeholder: 'Any other information that might be helpful...'
83109

84-
- type: textarea
85-
id: reproduce
110+
- type: checkboxes
111+
id: terms
86112
attributes:
87-
label: Reproducibility
88-
description: How consistently can you reproduce this bug?
89-
placeholder: |
90-
- Always
91-
- Sometimes
92-
- Only with specific conditions
113+
label: Code of Conduct
114+
options:
115+
- label: I agree to follow this project's [Code of Conduct](../CODE_OF_CONDUCT.md)
116+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://github.com/badhope/HumanOS#readme
5+
about: Check the README for usage instructions and FAQs
6+
- name: 💬 Discussions
7+
url: https://github.com/badhope/HumanOS/discussions
8+
about: Ask questions and discuss ideas with the community
9+
- name: 🔒 Security Issues
10+
url: https://github.com/badhope/HumanOS/security/advisories
11+
about: Report security vulnerabilities privately
Lines changed: 53 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,67 @@
1-
name: Documentation Update
2-
description: Improve project documentation
3-
title: '[DOCS] '
4-
labels: ['documentation']
1+
---
2+
name: Documentation
3+
description: Report issues or suggest improvements for documentation
4+
title: '[Docs]: '
5+
labels: ['documentation', 'needs-triage']
56
assignees: []
67
body:
7-
- type: textarea
8-
id: description
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for helping improve our documentation! Please fill out the sections below.
12+
13+
- type: dropdown
14+
id: type
15+
attributes:
16+
label: Documentation Type
17+
description: What type of documentation issue is this?
18+
options:
19+
- Missing Documentation
20+
- Incorrect/Outdated Information
21+
- Typo/Grammar Error
22+
- Unclear Explanation
23+
- Broken Link
24+
- Suggestion for Improvement
25+
- Translation Request
26+
validations:
27+
required: true
28+
29+
- type: input
30+
id: location
931
attributes:
10-
label: Description
11-
description: A clear description of the documentation change
12-
placeholder: Describe what documentation you've added or updated...
32+
label: Documentation Location
33+
description: Where is the documentation issue located?
34+
placeholder: 'e.g., README.md, CONTRIBUTING.md, API docs, etc.'
1335
validations:
1436
required: true
1537

1638
- type: textarea
17-
id: files
39+
id: current
1840
attributes:
19-
label: Files Changed
20-
description: List the documentation files changed
21-
placeholder: |
22-
- README.md
23-
- CONTRIBUTING.md
24-
- src/pages/Home.tsx (comments)
41+
label: Current Documentation
42+
description: What does the current documentation say? (if applicable)
43+
placeholder: 'Copy and paste the current text here...'
2544

2645
- type: textarea
27-
id: reason
46+
id: suggested
2847
attributes:
29-
label: Reason for Change
30-
description: Why is this documentation change necessary?
31-
placeholder: Explain why this change is needed...
48+
label: Suggested Improvement
49+
description: What should the documentation say instead?
50+
placeholder: 'Describe your suggested changes...'
51+
validations:
52+
required: true
3253

3354
- type: textarea
34-
id: preview
55+
id: additional
56+
attributes:
57+
label: Additional Context
58+
description: Add any other context about the documentation issue here
59+
placeholder: 'Any other information that might be helpful...'
60+
61+
- type: checkboxes
62+
id: terms
3563
attributes:
36-
label: Documentation Preview
37-
description: If applicable, show how the docs will look
38-
placeholder: Paste markdown or screenshot here
64+
label: Code of Conduct
65+
options:
66+
- label: I agree to follow this project's [Code of Conduct](../CODE_OF_CONDUCT.md)
67+
required: true
Lines changed: 59 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,102 @@
1+
---
12
name: Feature Request
2-
description: Suggest a new feature or improvement
3-
title: '[FEATURE] '
4-
labels: ['enhancement', 'needs triage']
3+
description: Suggest a new feature or enhancement for HumanOS
4+
title: '[Feature]: '
5+
labels: ['enhancement', 'needs-triage']
56
assignees: []
67
body:
78
- type: markdown
89
attributes:
910
value: |
10-
## 💡 Feature Request
11-
12-
Have an idea for a new feature? We'd love to hear it! Please fill out the form below.
13-
14-
- type: textarea
15-
id: summary
11+
Thanks for taking the time to suggest a new feature! Please fill out the sections below to help us understand your idea.
12+
13+
- type: checkboxes
14+
id: prerequisites
1615
attributes:
17-
label: Feature Summary
18-
description: A brief summary of the feature
19-
placeholder: Summary of your feature request
20-
validations:
21-
required: true
16+
label: Prerequisites
17+
options:
18+
- label: I have searched for existing issues that request this feature
19+
required: true
20+
- label: I have checked the [roadmap](../CHANGELOG.md#upcoming-features) for planned features
21+
required: true
22+
- label: I have read the [Contributing Guide](../CONTRIBUTING.md)
23+
required: false
2224

2325
- type: textarea
2426
id: problem
2527
attributes:
2628
label: Problem Statement
27-
description: What problem does this feature solve?
28-
placeholder: Describe the problem this feature would solve...
29+
description: Is your feature request related to a problem? Please describe it.
30+
placeholder: "I'm always frustrated when..."
2931
validations:
3032
required: true
3133

3234
- type: textarea
3335
id: solution
3436
attributes:
3537
label: Proposed Solution
36-
description: How would you like to see this problem solved?
37-
placeholder: Describe your proposed solution...
38+
description: A clear and concise description of what you want to happen
39+
placeholder: "I would like to see..."
3840
validations:
3941
required: true
4042

4143
- type: textarea
4244
id: alternatives
4345
attributes:
4446
label: Alternatives Considered
45-
description: Any alternative solutions you've considered?
46-
placeholder: Describe alternative solutions...
47+
description: A clear and concise description of any alternative solutions or features you've considered
48+
placeholder: "I have considered..."
4749

48-
- type: textarea
49-
id: mockups
50+
- type: dropdown
51+
id: category
5052
attributes:
51-
label: Mockups / Examples
52-
description: Any mockups, wireframes, or examples?
53-
placeholder: Drag and drop or paste images here
53+
label: Feature Category
54+
description: What category does this feature belong to?
55+
options:
56+
- Assessment & Testing
57+
- User Interface & Experience
58+
- Animation & Visual Effects
59+
- User System & Profiles
60+
- Data & Analytics
61+
- Performance & Optimization
62+
- Accessibility
63+
- Internationalization
64+
- Developer Experience
65+
- Other
66+
validations:
67+
required: true
5468

5569
- type: dropdown
5670
id: priority
5771
attributes:
5872
label: Priority
59-
description: How important is this feature?
73+
description: How important is this feature to you?
6074
options:
61-
- Low (Nice to have)
62-
- Medium (Would improve UX)
63-
- High (Critical for my use case)
64-
- Critical (Blocks my work)
75+
- Nice to have
76+
- Important
77+
- Very Important
78+
- Critical
6579
validations:
6680
required: true
6781

68-
- type: dropdown
69-
id: difficulty
82+
- type: textarea
83+
id: mockups
7084
attributes:
71-
label: Technical Difficulty
72-
description: How technically complex is this feature?
73-
options:
74-
- Easy (Straightforward implementation)
75-
- Medium (Requires some research)
76-
- Hard (Complex implementation)
77-
- Unknown
85+
label: Mockups/Examples
86+
description: Add any mockups, screenshots, or examples of similar features in other products
87+
placeholder: 'Drag and drop images or paste URLs here'
7888

7989
- type: textarea
8090
id: additional
8191
attributes:
8292
label: Additional Context
83-
description: Any other context or requirements?
84-
placeholder: Additional context...
93+
description: Add any other context about the feature request here
94+
placeholder: 'Any other information that might be helpful...'
95+
96+
- type: checkboxes
97+
id: terms
98+
attributes:
99+
label: Code of Conduct
100+
options:
101+
- label: I agree to follow this project's [Code of Conduct](../CODE_OF_CONDUCT.md)
102+
required: true

0 commit comments

Comments
 (0)