chore(release): final release commit for 0.1.0
this commit includes a whole lotta fuck yeah, a whole lotta we fuckin got this, and a lot of "please change the future." i hope it works. Signed-off-by: Sienna Meridian Satterwhite <sienna@r3t.io>
This commit is contained in:
68
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
68
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug to help us improve Marathon
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Bug Description
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## Minimal, Complete, Verifiable Example (MCVE)
|
||||
|
||||
Please provide the **smallest possible code example** that demonstrates the bug. This helps us reproduce and fix the issue faster.
|
||||
|
||||
### Minimal Code Example
|
||||
|
||||
```rust
|
||||
// Paste your minimal reproducible code here
|
||||
// Remove anything not necessary to demonstrate the bug
|
||||
```
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
4.
|
||||
|
||||
### Expected Behavior
|
||||
|
||||
What you expected to happen:
|
||||
|
||||
### Actual Behavior
|
||||
|
||||
What actually happened:
|
||||
|
||||
## Environment
|
||||
|
||||
- **OS**: [e.g., macOS 15.0, iOS 18.2]
|
||||
- **Rust Version**: [e.g., 1.85.0 - run `rustc --version`]
|
||||
- **Marathon Version/Commit**: [e.g., v0.1.0 or commit hash]
|
||||
- **Platform**: [Desktop / iOS Simulator / iOS Device]
|
||||
|
||||
## Logs/Stack Traces
|
||||
|
||||
If applicable, paste any error messages or stack traces here:
|
||||
|
||||
```
|
||||
paste logs here
|
||||
```
|
||||
|
||||
## Screenshots/Videos
|
||||
|
||||
If applicable, add screenshots or videos to help explain the problem.
|
||||
|
||||
## Additional Context
|
||||
|
||||
Add any other context about the problem here. For example:
|
||||
- Does it happen every time or intermittently?
|
||||
- Did this work in a previous version?
|
||||
- Are you running multiple instances?
|
||||
- Any relevant configuration or network setup?
|
||||
|
||||
## Possible Solution
|
||||
|
||||
If you have ideas about what might be causing the issue or how to fix it, please share them here.
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Question or Discussion
|
||||
url: https://github.com/r3t-studios/marathon/discussions
|
||||
about: Ask questions or discuss ideas with the community
|
||||
- name: Security Vulnerability
|
||||
url: https://github.com/r3t-studios/marathon/security/policy
|
||||
about: Please report security issues privately (see SECURITY.md)
|
||||
72
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
72
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new feature or enhancement for Marathon
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
|
||||
A clear and concise description of what the problem is. For example:
|
||||
- "I'm always frustrated when..."
|
||||
- "It's difficult to..."
|
||||
- "Users need to be able to..."
|
||||
|
||||
## Feature Request (Given-When-Then Format)
|
||||
|
||||
Please describe your feature request using the Given-When-Then format to make the behavior clear:
|
||||
|
||||
### Scenario 1: [Brief scenario name]
|
||||
|
||||
**Given** [initial context or preconditions]
|
||||
**When** [specific action or event]
|
||||
**Then** [expected outcome]
|
||||
|
||||
**Example:**
|
||||
- **Given** I am editing a collaborative document with 3 other peers
|
||||
- **When** I lose network connectivity for 5 minutes
|
||||
- **Then** my local changes should be preserved and sync automatically when I reconnect
|
||||
|
||||
### Scenario 2: [Additional scenario if needed]
|
||||
|
||||
**Given** [initial context]
|
||||
**When** [action]
|
||||
**Then** [outcome]
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
**Describe alternatives you've considered.**
|
||||
|
||||
Have you thought of other ways to solve this problem? What are the pros and cons of different approaches?
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
**Do you have thoughts on implementation?**
|
||||
|
||||
If you have ideas about how this could be implemented technically, share them here. For example:
|
||||
- Which modules might be affected
|
||||
- Potential challenges or dependencies
|
||||
- Performance implications
|
||||
- Breaking changes required
|
||||
|
||||
## Additional Context
|
||||
|
||||
Add any other context, mockups, screenshots, or examples from other projects that illustrate the feature.
|
||||
|
||||
## Priority/Impact
|
||||
|
||||
How important is this feature to you or your use case?
|
||||
- [ ] Critical - blocking current work
|
||||
- [ ] High - would significantly improve workflow
|
||||
- [ ] Medium - nice to have
|
||||
- [ ] Low - minor improvement
|
||||
|
||||
## Willingness to Contribute
|
||||
|
||||
- [ ] I'm willing to implement this feature
|
||||
- [ ] I can help test this feature
|
||||
- [ ] I can help with documentation
|
||||
- [ ] I'm just suggesting the idea
|
||||
117
.github/pull_request_template.md
vendored
Normal file
117
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,117 @@
|
||||
## Description
|
||||
|
||||
<!-- Provide a clear and concise description of what this PR does -->
|
||||
|
||||
## Related Issues
|
||||
|
||||
<!-- Link to related issues using #issue_number -->
|
||||
Fixes #
|
||||
Relates to #
|
||||
|
||||
## Type of Change
|
||||
|
||||
<!-- Mark relevant items with an [x] -->
|
||||
|
||||
- [ ] Bug fix (non-breaking change that fixes an issue)
|
||||
- [ ] New feature (non-breaking change that adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] Documentation update
|
||||
- [ ] Refactoring (no functional changes)
|
||||
- [ ] Performance improvement
|
||||
- [ ] Test coverage improvement
|
||||
|
||||
## Changes Made
|
||||
|
||||
<!-- List the specific changes in this PR -->
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
## Testing Performed
|
||||
|
||||
<!-- Describe the testing you've done -->
|
||||
|
||||
- [ ] All existing tests pass (`cargo nextest run`)
|
||||
- [ ] Added new tests for new functionality
|
||||
- [ ] Tested manually on desktop
|
||||
- [ ] Tested manually on iOS (if applicable)
|
||||
- [ ] Tested with multiple instances
|
||||
- [ ] Tested edge cases and error conditions
|
||||
|
||||
### Test Details
|
||||
|
||||
<!-- Provide specific details about your testing -->
|
||||
|
||||
**Desktop:**
|
||||
-
|
||||
|
||||
**iOS:** (if applicable)
|
||||
-
|
||||
|
||||
**Multi-instance:** (if applicable)
|
||||
-
|
||||
|
||||
## Documentation
|
||||
|
||||
<!-- Mark relevant items with an [x] -->
|
||||
|
||||
- [ ] Updated relevant documentation in `/docs`
|
||||
- [ ] Updated README.md (if public API changed)
|
||||
- [ ] Added doc comments to new public APIs
|
||||
- [ ] Updated CHANGELOG.md
|
||||
|
||||
## Code Quality
|
||||
|
||||
<!-- Confirm these items -->
|
||||
|
||||
- [ ] Code follows project style guidelines
|
||||
- [ ] Ran `cargo +nightly fmt`
|
||||
- [ ] Ran `cargo clippy` and addressed warnings
|
||||
- [ ] No new compiler warnings
|
||||
- [ ] Added meaningful variable/function names
|
||||
|
||||
## AI Usage
|
||||
|
||||
<!-- If you used AI tools, briefly note how (see AI_POLICY.md) -->
|
||||
<!-- You don't need to disclose simple autocomplete, only substantial AI assistance -->
|
||||
|
||||
- [ ] No AI assistance used
|
||||
- [ ] Used AI tools (brief description below)
|
||||
|
||||
<!-- If used: -->
|
||||
<!-- AI tool: [e.g., Claude, Copilot] -->
|
||||
<!-- How: [e.g., "Used to generate boilerplate, then reviewed and modified"] -->
|
||||
<!-- I reviewed, understand, and am accountable for all code in this PR -->
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
<!-- If this is a breaking change, describe what breaks and how to migrate -->
|
||||
|
||||
**Does this PR introduce breaking changes?**
|
||||
- [ ] No
|
||||
- [ ] Yes (describe below)
|
||||
|
||||
<!-- If yes: -->
|
||||
<!-- - What breaks: -->
|
||||
<!-- - Migration path: -->
|
||||
|
||||
## Screenshots/Videos
|
||||
|
||||
<!-- If applicable, add screenshots or videos showing the changes -->
|
||||
|
||||
## Checklist
|
||||
|
||||
<!-- Final checks before requesting review -->
|
||||
|
||||
- [ ] My code follows the project's coding standards
|
||||
- [ ] I have tested my changes thoroughly
|
||||
- [ ] I have updated relevant documentation
|
||||
- [ ] I have added tests that prove my fix/feature works
|
||||
- [ ] All tests pass locally
|
||||
- [ ] I have read and followed the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
|
||||
- [ ] I understand and accept the [AI_POLICY.md](../AI_POLICY.md)
|
||||
|
||||
## Additional Notes
|
||||
|
||||
<!-- Any additional information reviewers should know -->
|
||||
Reference in New Issue
Block a user