Skip to content

Commit efdb12f

Browse files
HenraLHenraL
committed
[ADD] files for a new community to be created (hopefully)
1 parent 6941c95 commit efdb12f

File tree

12 files changed

+634
-4
lines changed

12 files changed

+634
-4
lines changed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/Asperguide/asper-header/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: Developer Documentation
7+
url: https://asperguide.github.io/asper-header/
8+
about: Read the full Doxygen-generated documentation
9+
- name: User Guide
10+
url: https://github.com/Asperguide/asper-header/blob/main/README.md
11+
about: Read the complete user guide and configuration options
12+
- name: Security Vulnerability
13+
url: https://github.com/Asperguide/asper-header/security/advisories/new
14+
about: Report a security vulnerability privately

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: Documentation Issue
3+
about: Report incorrect, missing, or unclear documentation
4+
title: '[DOCS] '
5+
labels: 'documentation'
6+
assignees: 'HenraL'
7+
8+
---
9+
10+
## Documentation Issue
11+
12+
**Which documentation is affected?**
13+
<!-- e.g., README.md, inline code comments, Doxygen docs, settings descriptions -->
14+
15+
**Location/Section:**
16+
<!-- Provide a link or section name -->
17+
18+
**Issue Type**
19+
20+
- [ ] Incorrect information
21+
- [ ] Missing information
22+
- [ ] Unclear/confusing explanation
23+
- [ ] Typo or grammar issue
24+
- [ ] Outdated information
25+
- [ ] Missing example
26+
- [ ] Translation issue
27+
28+
**Current Content**
29+
<!-- Quote the problematic section or describe what's currently there -->
30+
31+
```
32+
Current documentation text here
33+
```
34+
35+
**Suggested Improvement**
36+
<!-- Describe what should be changed or provide corrected text -->
37+
38+
```
39+
Suggested documentation text here
40+
```
41+
42+
**Additional Context**
43+
<!-- Add any other context, screenshots, or examples -->
44+
45+
**Affected Languages**
46+
<!-- If this is a translation issue, list which languages are affected -->
47+
- [ ] English (en)
48+
- [ ] French (fr)
49+
- [ ] Spanish (es)
50+
- [ ] German (de)
51+
- [ ] Japanese (ja)
52+
- [ ] Korean (ko)
53+
- [ ] Russian (ru)
54+
- [ ] Portuguese (pt-br)
55+
- [ ] Turkish (tr)
56+
- [ ] Polish (pl)
57+
- [ ] Czech (cs)
58+
- [ ] Hungarian (hu)
59+
- [ ] Chinese Simplified (zh-cn)
60+
- [ ] Chinese Traditional (zh-tw)
61+
- [ ] Italian (it)

‎.github/ISSUE_TEMPLATE/language_support.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: Language Support Request
3+
about: Request support for a new programming language or file type
4+
title: '[LANGUAGE] Add support for '
5+
labels: 'enhancement, language-support'
6+
assignees: 'HenraL'
7+
8+
---
9+
10+
## Language Support Request
11+
12+
**Language/File Type**
13+
<!-- e.g., Julia, Dart, Fortran, .proto files, etc. -->
14+
15+
**Language Information**
16+
17+
- **Official Website**:
18+
- **File Extensions**: <!-- e.g., .jl, .dart, .f90 -->
19+
- **VS Code Language ID**: <!-- Check with Command Palette > "Change Language Mode" -->
20+
21+
**Comment Syntax**
22+
<!-- Provide examples of how comments work in this language -->
23+
24+
**Single-line comments:**
25+
26+
```
27+
// Example single-line comment
28+
```
29+
30+
**Multi-line comments:**
31+
32+
```
33+
/*
34+
* Example multi-line comment
35+
*/
36+
```
37+
38+
**Documentation comments** (if different):
39+
40+
```
41+
/// Example documentation comment
42+
```
43+
44+
**Use Case**
45+
<!-- Describe why you need AsperHeader support for this language -->
46+
47+
**Current Workaround**
48+
<!-- If you've found a temporary solution, share it here -->
49+
50+
**Example Header**
51+
<!-- Show what an ideal header would look like in this language -->
52+
53+
```language-name
54+
[Paste example of desired header here]
55+
```
56+
57+
**Popularity/Relevance**
58+
<!-- Help us prioritize: Is this widely used? Part of a specific ecosystem? -->
59+
60+
**Additional Context**
61+
<!-- Any special considerations, edge cases, or requirements -->
62+
63+
---
64+
65+
**Checklist for Implementation** (for maintainers):
66+
67+
- [ ] Add language to `languages.json`
68+
- [ ] Test comment detection
69+
- [ ] Test header generation
70+
- [ ] Test header refresh
71+
- [ ] Update documentation
72+
- [ ] Add test case

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: Question / Support
3+
about: Ask a question or get help using AsperHeader
4+
title: '[QUESTION] '
5+
labels: 'question'
6+
assignees: 'HenraL'
7+
8+
---
9+
10+
## Question / Support Request
11+
12+
**Question**
13+
<!-- Ask your question clearly and concisely -->
14+
15+
**What I'm Trying to Do**
16+
<!-- Describe what you're trying to accomplish -->
17+
18+
**What I've Tried**
19+
<!-- List the approaches or configurations you've already attempted -->
20+
21+
1.
22+
2.
23+
3.
24+
25+
**Current Configuration**
26+
<!-- Share relevant settings from your VS Code settings.json -->
27+
28+
```json
29+
{
30+
"asperheader.projectName": "",
31+
"asperheader.projectCopyright": "",
32+
// Add other relevant settings
33+
}
34+
```
35+
36+
**Environment**
37+
38+
- **VS Code Version**: <!-- e.g., 1.104.0 -->
39+
- **AsperHeader Version**: <!-- e.g., 1.0.18 -->
40+
- **Operating System**: <!-- e.g., Windows 11, macOS 14, Ubuntu 22.04 -->
41+
- **Language/File Type**: <!-- e.g., Python, JavaScript, C++ -->
42+
43+
**Screenshots**
44+
<!-- If applicable, add screenshots to help explain your question -->
45+
46+
**Expected Outcome**
47+
<!-- What result are you hoping to achieve? -->
48+
49+
**Additional Context**
50+
<!-- Add any other context about your question -->
51+
52+
---
53+
54+
**Note**: For bug reports, please use the [Bug Report template](bug_report.md) instead.
55+
For feature requests, please use the [Feature Request template](feature_request.md) instead.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Code refactoring
14+
- [ ] Performance improvement
15+
- [ ] Test coverage improvement
16+
- [ ] Dependency update
17+
18+
## Related Issues
19+
20+
<!-- Link to related issues using #issue_number -->
21+
22+
Fixes #
23+
Relates to #
24+
25+
## Changes Made
26+
27+
<!-- Provide a detailed list of changes -->
28+
29+
-
30+
-
31+
-
32+
33+
## Testing Performed
34+
35+
<!-- Describe the testing you performed to verify your changes -->
36+
37+
- [ ] Tested manually in VS Code
38+
- [ ] Added/updated unit tests
39+
- [ ] All existing tests pass
40+
- [ ] Tested with multiple languages
41+
- [ ] Tested on different operating systems (Windows/macOS/Linux)
42+
43+
## Screenshots/Recordings
44+
45+
<!-- If applicable, add screenshots or GIFs demonstrating the changes -->
46+
47+
## Checklist
48+
49+
- [ ] My code follows the project's [commit conventions](COMMIT_CONVENTION.md)
50+
- [ ] I have performed a self-review of my code
51+
- [ ] I have commented my code, particularly in hard-to-understand areas
52+
- [ ] I have updated the documentation accordingly
53+
- [ ] My changes generate no new warnings or errors
54+
- [ ] I have added tests that prove my fix is effective or that my feature works
55+
- [ ] New and existing unit tests pass locally with my changes
56+
- [ ] I have updated the CHANGELOG.md file
57+
- [ ] Any dependent changes have been merged and published
58+
59+
## Language Support
60+
61+
<!-- If your changes affect language support or translations -->
62+
63+
- [ ] Added/updated translations for all supported languages
64+
- [ ] Verified message keys exist in messageReference.ts
65+
- [ ] Tested fallback to English for missing translations
66+
67+
## Additional Context
68+
69+
<!-- Add any other context about the pull request here -->

0 commit comments

Comments
 (0)