Initial: add README, CONTRIBUTING, LICENSE, and research template
This commit is contained in:
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Contributing
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Create a branch for your work: `git checkout -b fix/issue-N-name` or `git checkout -b docs/topic-name`
|
||||
2. Make changes and commit with clear messages
|
||||
3. Open a Pull Request for review
|
||||
4. Do not merge directly to `master` for reviewable changes
|
||||
5. After approval, squash and merge
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Use clear, descriptive commit messages
|
||||
- Keep PRs focused and reasonably sized
|
||||
- Document any non-obvious decisions
|
||||
- Test changes before submitting
|
||||
|
||||
## Branches
|
||||
|
||||
- `master` — stable, reviewed content only
|
||||
- `fix/*` — bug fixes
|
||||
- `docs/*` — documentation updates
|
||||
- `research/*` — new research notes
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
23
README.md
Normal file
23
README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# kugetsu
|
||||
|
||||
Research notes and documentation repository.
|
||||
|
||||
> **Name background:** _to be documented_
|
||||
|
||||
## Overview
|
||||
|
||||
This repository contains research findings, experiments, and documentation on various topics.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
├── README.md
|
||||
├── CONTRIBUTING.md
|
||||
├── LICENSE
|
||||
└── docs/
|
||||
└── ...
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
35
docs/_template.md
Normal file
35
docs/_template.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Research: [Topic]
|
||||
|
||||
**Date:** YYYY-MM-DD
|
||||
**Status:** In Progress | Completed | Archived
|
||||
|
||||
## Summary
|
||||
|
||||
Brief overview of the research topic.
|
||||
|
||||
## Background
|
||||
|
||||
Why this matters and context.
|
||||
|
||||
## Findings
|
||||
|
||||
### Key Discovery 1
|
||||
|
||||
Description...
|
||||
|
||||
### Key Discovery 2
|
||||
|
||||
Description...
|
||||
|
||||
## Notes
|
||||
|
||||
- Point 1
|
||||
- Point 2
|
||||
|
||||
## References
|
||||
|
||||
- [Link description](URL)
|
||||
|
||||
## Status History
|
||||
|
||||
- YYYY-MM-DD: Initial research started
|
||||
Reference in New Issue
Block a user