mirror of
https://github.com/flakestorm/flakestorm.git
synced 2026-04-26 09:16:25 +02:00
Update README.md and CONTRIBUTING.md to enhance project visibility and support for new contributors. Added PyPI version and download badges, build status, and latest release information to README.md. Introduced a section in CONTRIBUTING.md for finding good first issues, providing guidance for beginners on how to contribute effectively.
This commit is contained in:
parent
d1aaa626c9
commit
2f4f2270b5
7 changed files with 266 additions and 0 deletions
45
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
45
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Create a report to help us improve
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Description
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## Steps to Reproduce
|
||||
1. Go to '...'
|
||||
2. Run command '...'
|
||||
3. See error
|
||||
|
||||
## Expected Behavior
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
A clear and concise description of what actually happened.
|
||||
|
||||
## Environment
|
||||
- **flakestorm version**: (e.g., 0.9.0)
|
||||
- **Python version**: (e.g., 3.10.5)
|
||||
- **Operating System**: (e.g., Windows 10, macOS 14.0, Ubuntu 22.04)
|
||||
- **Ollama version** (if applicable): (e.g., 0.1.0)
|
||||
|
||||
## Configuration
|
||||
If applicable, include relevant parts of your `flakestorm.yaml` configuration (remove any sensitive information):
|
||||
|
||||
```yaml
|
||||
# Your configuration here
|
||||
```
|
||||
|
||||
## Error Messages / Logs
|
||||
```
|
||||
Paste any error messages or logs here
|
||||
```
|
||||
|
||||
## Additional Context
|
||||
Add any other context about the problem here. Include:
|
||||
- Screenshots if applicable
|
||||
- Related issues
|
||||
- Workarounds you've tried
|
||||
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: false
|
||||
contact_links:
|
||||
- name: Documentation
|
||||
url: https://flakestorm.dev/docs
|
||||
about: Check our documentation for usage guides and examples
|
||||
- name: Community Discussions
|
||||
url: https://github.com/flakestorm/flakestorm/discussions
|
||||
about: Ask questions and share ideas with the community
|
||||
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
name: Feature Request
|
||||
about: Suggest an idea for this project
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Feature Description
|
||||
A clear and concise description of the feature you'd like to see.
|
||||
|
||||
## Problem Statement
|
||||
What problem does this feature solve? What use case does it address?
|
||||
|
||||
## Proposed Solution
|
||||
Describe how you envision this feature working. Include:
|
||||
- User-facing changes (CLI, config, etc.)
|
||||
- Technical approach (if you have ideas)
|
||||
- Examples of how it would be used
|
||||
|
||||
## Alternatives Considered
|
||||
Describe any alternative solutions or features you've considered.
|
||||
|
||||
## Additional Context
|
||||
- Is this feature related to a specific use case?
|
||||
- Would this be better suited for the cloud version?
|
||||
- Any related issues or discussions?
|
||||
|
||||
## Implementation Notes (Optional)
|
||||
If you're planning to implement this yourself, outline your approach here.
|
||||
24
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
24
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
name: Question
|
||||
about: Ask a question about flakestorm
|
||||
title: '[QUESTION] '
|
||||
labels: question
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Question
|
||||
What would you like to know?
|
||||
|
||||
## Context
|
||||
Provide any relevant context:
|
||||
- What are you trying to accomplish?
|
||||
- What have you tried so far?
|
||||
- What documentation have you reviewed?
|
||||
|
||||
## Environment (if relevant)
|
||||
- **flakestorm version**: (e.g., 0.9.0)
|
||||
- **Python version**: (e.g., 3.10.5)
|
||||
- **Operating System**: (e.g., Windows 10, macOS 14.0, Ubuntu 22.04)
|
||||
|
||||
## Additional Information
|
||||
Any other information that might help answer your question.
|
||||
Loading…
Add table
Add a link
Reference in a new issue