Initial commit
This commit is contained in:
69
.github/README.md
vendored
Normal file
69
.github/README.md
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
# Memory Palace - GitHub Structure
|
||||
|
||||
This directory contains templates and configurations for GitHub.
|
||||
|
||||
## 📁 Structure
|
||||
|
||||
### `copilot-instructions.md`
|
||||
|
||||
GitHub Copilot instructions that guide AI assistance for this workspace. Defines:
|
||||
|
||||
- Project overview and structure
|
||||
- Documentation and code conventions
|
||||
- File organization and naming
|
||||
- Commit practices
|
||||
|
||||
### `ISSUE_TEMPLATE/`
|
||||
|
||||
Issue templates for tracking:
|
||||
|
||||
- **concept-idea.md** - New concepts and ideas
|
||||
- **bookmarklet-request.md** - Browser utility requests
|
||||
- **code-experiment.md** - Code experiments and prototypes
|
||||
- **project-documentation.md** - Larger project tracking
|
||||
- **bug-report.md** - Bug reports and issues
|
||||
- **config.yml** - Template configuration
|
||||
|
||||
### `PULL_REQUEST_TEMPLATE.md`
|
||||
|
||||
Template for pull requests (if collaborating or tracking larger changes)
|
||||
|
||||
## 🎯 Usage
|
||||
|
||||
### For Issues
|
||||
|
||||
Use issues to track:
|
||||
|
||||
- Ideas you want to develop into notes
|
||||
- Bookmarklets you want to build
|
||||
- Code experiments
|
||||
- Project planning
|
||||
- Problems to fix
|
||||
|
||||
### For Copilot
|
||||
|
||||
The instructions file helps Copilot:
|
||||
|
||||
- Understand your project structure
|
||||
- Suggest appropriate file locations
|
||||
- Follow your naming conventions
|
||||
- Generate code matching your style
|
||||
- Create documentation in your format
|
||||
|
||||
## 🔧 Customization
|
||||
|
||||
Feel free to:
|
||||
|
||||
- Add new issue templates for your workflows
|
||||
- Modify the copilot instructions as your needs evolve
|
||||
- Create additional GitHub workflows
|
||||
- Add labels in the repository settings
|
||||
|
||||
## 📝 Future Additions
|
||||
|
||||
Consider adding:
|
||||
|
||||
- `workflows/` - GitHub Actions for automation
|
||||
- `CODEOWNERS` - If you collaborate with others
|
||||
- `FUNDING.yml` - If you want to add sponsorship options
|
||||
- Label definitions and automation
|
||||
Reference in New Issue
Block a user