Skip to content
This repository was archived by the owner on Nov 10, 2025. It is now read-only.

Commit 5e154d6

Browse files
OlanetsoftOlanetsoft
committed
feat: add midnight-template-repo compliance files for org transfer
Add all required compliance files and configurations to align with midnightntwrk organization standards in preparation for future repository transfer. Compliance Files Added: - LICENSE: Apache 2.0 license - SECURITY.md: Vulnerability reporting policy - CONTRIBUTING.md: Contribution guidelines with CLA requirement - CODE_OF_CONDUCT.md: Contributor Covenant 1.4 - CHANGELOG.md: Keep a Changelog format (v0.0.6 through v0.3.4) - CODEOWNERS: Repository ownership structure - .envrc: Git config for signed commits GitHub Templates: - .github/ISSUE_TEMPLATE/bug_report.md - .github/ISSUE_TEMPLATE/feature_request.md - .github/ISSUE_TEMPLATE/documentation.md - .github/PULL_REQUEST_TEMPLATE.md SPDX License Headers: - Added Apache 2.0 headers to all 18 TypeScript source files - Format: "This file is part of create-mn-app" - Copyright (C) 2025 Midnight Foundation Package Updates: - Changed license from MIT to Apache-2.0 in package.json - Updated README.md license badge and footer - Maintained version 0.3.4 (not published yet) All changes follow midnight-template-repo standards and are ready for future transfer to midnightntwrk organization. Refs: #compliance #apache-2.0 #midnight-foundation
1 parent cf2266c commit 5e154d6

29 files changed

+1471
-3
lines changed

‎.envrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# point out to users at commit time that commits need to be signed,
2+
# not once they've done many commits and are trying to push a PR:
3+
git config --local commit.gpgSign true
4+
git config --local tag.gpgSign true

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
Steps to reproduce the behavior:
16+
17+
1. Run command '...'
18+
2. Select option '...'
19+
3. See error
20+
21+
## Expected Behavior
22+
23+
A clear and concise description of what you expected to happen.
24+
25+
## Actual Behavior
26+
27+
A clear and concise description of what actually happened.
28+
29+
## Environment
30+
31+
- **OS**: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11]
32+
- **Node.js Version**: [e.g., 22.0.0]
33+
- **Package Manager**: [e.g., npm 10.0.0, yarn 1.22.0]
34+
- **create-mn-app Version**: [e.g., 0.3.4]
35+
- **Installation Method**: [e.g., npx, global install]
36+
37+
## Error Messages
38+
39+
```
40+
Paste any error messages or stack traces here
41+
```
42+
43+
## Screenshots
44+
45+
If applicable, add screenshots to help explain your problem.
46+
47+
## Additional Context
48+
49+
Add any other context about the problem here.
50+
51+
## Possible Solution
52+
53+
If you have suggestions on how to fix the bug, please describe them here.
54+
55+
## Checklist
56+
57+
- [ ] I have checked existing issues to ensure this is not a duplicate
58+
- [ ] I have provided all the requested information
59+
- [ ] I have tested with the latest version of create-mn-app
60+
- [ ] I have included error messages and logs

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Documentation Improvement
3+
about: Suggest improvements to documentation
4+
title: "[DOCS] "
5+
labels: "documentation"
6+
assignees: ""
7+
---
8+
9+
## Documentation Issue
10+
11+
### Location
12+
13+
Which documentation needs improvement?
14+
15+
- [ ] README.md
16+
- [ ] CONTRIBUTING.md
17+
- [ ] API Documentation
18+
- [ ] Code Comments
19+
- [ ] Examples
20+
- [ ] Other: **\_**
21+
22+
### Specific Section/Page
23+
24+
Please specify the exact section, file, or page that needs improvement.
25+
26+
## Current State
27+
28+
Describe what the current documentation says or how it currently appears.
29+
30+
```
31+
Quote or screenshot the current documentation if applicable
32+
```
33+
34+
## Suggested Improvement
35+
36+
Describe how you think the documentation should be improved.
37+
38+
### Proposed Changes
39+
40+
What specific changes would you like to see?
41+
42+
```
43+
Provide the suggested text or description of changes
44+
```
45+
46+
## Reason for Improvement
47+
48+
Why is this improvement needed?
49+
50+
- [ ] Information is missing
51+
- [ ] Information is incorrect
52+
- [ ] Information is unclear or confusing
53+
- [ ] Information is outdated
54+
- [ ] Needs more examples
55+
- [ ] Needs better formatting
56+
- [ ] Other: **\_**
57+
58+
## Additional Context
59+
60+
Add any other context, screenshots, or examples about the documentation improvement here.
61+
62+
## Impact
63+
64+
Who would benefit from this improvement?
65+
66+
- [ ] New users/beginners
67+
- [ ] Experienced users
68+
- [ ] Contributors
69+
- [ ] All users
70+
71+
## Checklist
72+
73+
- [ ] I have checked that this documentation issue hasn't already been reported
74+
- [ ] I have clearly described the problem and suggested improvement
75+
- [ ] I have specified the exact location of the documentation
76+
- [ ] I am willing to submit a PR with the changes (optional)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Problem Statement
14+
15+
Is your feature request related to a problem? Please describe.
16+
Ex. I'm always frustrated when [...]
17+
18+
## Proposed Solution
19+
20+
Describe the solution you'd like to see implemented.
21+
22+
## Alternatives Considered
23+
24+
Describe any alternative solutions or features you've considered.
25+
26+
## Use Cases
27+
28+
Describe the use cases for this feature. How would it benefit users?
29+
30+
1. Use case 1...
31+
2. Use case 2...
32+
33+
## Examples from Other Tools
34+
35+
If applicable, provide examples of this feature in other similar tools.
36+
37+
## Implementation Ideas
38+
39+
If you have ideas on how this could be implemented, share them here.
40+
41+
## Additional Context
42+
43+
Add any other context, screenshots, or mockups about the feature request here.
44+
45+
## Benefits
46+
47+
- Benefit 1
48+
- Benefit 2
49+
- Benefit 3
50+
51+
## Potential Drawbacks
52+
53+
Are there any potential drawbacks or concerns with this feature?
54+
55+
## Checklist
56+
57+
- [ ] I have checked existing issues to ensure this is not a duplicate
58+
- [ ] I have clearly described the feature and its benefits
59+
- [ ] I have provided use cases
60+
- [ ] I have considered potential drawbacks

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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 update
16+
- [ ] Build/CI update
17+
- [ ] Other (please describe):
18+
19+
## Related Issues
20+
21+
<!-- Link to related issues using #issue_number -->
22+
23+
Fixes #
24+
Closes #
25+
Related to #
26+
27+
## Motivation and Context
28+
29+
<!-- Why is this change required? What problem does it solve? -->
30+
31+
## Changes Made
32+
33+
<!-- List the specific changes made in this PR -->
34+
35+
- Change 1
36+
- Change 2
37+
- Change 3
38+
39+
## Testing Performed
40+
41+
<!-- Describe the tests you ran to verify your changes -->
42+
43+
### Manual Testing
44+
45+
- [ ] Tested on macOS
46+
- [ ] Tested on Linux
47+
- [ ] Tested on Windows
48+
- [ ] Tested with npm
49+
- [ ] Tested with yarn
50+
- [ ] Tested with pnpm
51+
- [ ] Tested with bun
52+
53+
### Test Commands
54+
55+
```bash
56+
# List the commands you used to test
57+
npm run build
58+
npm test
59+
npm link
60+
create-mn-app test-project
61+
```
62+
63+
### Test Results
64+
65+
<!-- Paste relevant test results or screenshots -->
66+
67+
## Screenshots/Videos
68+
69+
<!-- If applicable, add screenshots or videos to demonstrate the changes -->
70+
71+
## Breaking Changes
72+
73+
<!-- If this PR introduces breaking changes, describe them here -->
74+
75+
- [ ] This PR introduces breaking changes
76+
- [ ] Migration guide updated (if applicable)
77+
78+
## Documentation
79+
80+
<!-- Have you updated the documentation? -->
81+
82+
- [ ] README.md updated (if needed)
83+
- [ ] CHANGELOG.md updated
84+
- [ ] Code comments updated
85+
- [ ] API documentation updated (if applicable)
86+
- [ ] Examples updated (if applicable)
87+
88+
## Checklist
89+
90+
<!-- Mark completed items with an "x" -->
91+
92+
### Code Quality
93+
94+
- [ ] My code follows the project's coding standards
95+
- [ ] I have performed a self-review of my code
96+
- [ ] I have commented my code, particularly in hard-to-understand areas
97+
- [ ] I have made corresponding changes to the documentation
98+
- [ ] My changes generate no new warnings or errors
99+
- [ ] I have added tests that prove my fix is effective or that my feature works
100+
- [ ] New and existing unit tests pass locally with my changes
101+
- [ ] Any dependent changes have been merged and published
102+
103+
### Licensing
104+
105+
- [ ] I have added SPDX license headers to any new files
106+
- [ ] I have signed the Contributor License Agreement (CLA)
107+
- [ ] I have read and agree to the [Code of Conduct](CODE_OF_CONDUCT.md)
108+
109+
### Dependencies
110+
111+
- [ ] I have checked that no unnecessary dependencies were added
112+
- [ ] Dependencies are up to date and secure
113+
- [ ] package.json and package-lock.json are in sync
114+
115+
## Additional Notes
116+
117+
<!-- Add any additional notes, concerns, or questions for reviewers -->
118+
119+
## Reviewer Guidelines
120+
121+
<!-- For reviewers: What should reviewers focus on? -->
122+
123+
Please pay special attention to:
124+
125+
-
126+
-
127+
-
128+
129+
---
130+
131+
**Note to reviewers**: This PR is ready for review. Please check the code quality, test coverage, and documentation completeness.

0 commit comments

Comments
 (0)