docs: Add community files and improve onboarding
- Add CODE_OF_CONDUCT.md at repository root - Add CONTRIBUTORS.md to recognize contributors - Add GitHub issue templates (bug report, feature request) - Add GitHub pull request template - Add Docker quickstart to README (fastest path to try) - Update Contributing section with links to guidelines 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
749dd76f9c
commit
d1417a1a3c
7 changed files with 235 additions and 0 deletions
48
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
48
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: Report a bug 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. Click on '...'
|
||||||
|
3. Run command '...'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
|
||||||
|
What you expected to happen.
|
||||||
|
|
||||||
|
## Actual Behavior
|
||||||
|
|
||||||
|
What actually happened.
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
- **OS**: [e.g., Ubuntu 22.04, Windows 11, macOS 14]
|
||||||
|
- **Go Version**: [e.g., 1.24.0]
|
||||||
|
- **Mining Platform Version**: [e.g., v1.0.0]
|
||||||
|
- **Miner Software**: [e.g., XMRig 6.21.0]
|
||||||
|
- **Hardware**: [e.g., AMD Ryzen 9, NVIDIA RTX 4090]
|
||||||
|
|
||||||
|
## Logs
|
||||||
|
|
||||||
|
```
|
||||||
|
Paste relevant log output here
|
||||||
|
```
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
|
||||||
|
Add any other context about the problem 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: Documentation
|
||||||
|
url: https://snider.github.io/Mining/
|
||||||
|
about: Check out the documentation before opening an issue
|
||||||
|
- name: Discussions
|
||||||
|
url: https://github.com/Snider/Mining/discussions
|
||||||
|
about: Ask questions and discuss ideas in GitHub Discussions
|
||||||
31
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
31
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
---
|
||||||
|
name: Feature Request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: '[FEATURE] '
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Use Case
|
||||||
|
|
||||||
|
Why is this feature needed? What problem does it solve?
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
## Proposed Solution
|
||||||
|
|
||||||
|
How do you think this should be implemented?
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
Have you considered any alternative solutions or features?
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
How would this feature work? Include examples, mockups, or references to similar features in other projects.
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
|
||||||
|
Add any other context, screenshots, or references about the feature request here.
|
||||||
46
.github/pull_request_template.md
vendored
Normal file
46
.github/pull_request_template.md
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Brief description of what this PR does.
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
||||||
|
Fixes #
|
||||||
|
Relates to #
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Added X functionality
|
||||||
|
- Fixed Y bug
|
||||||
|
- Updated Z documentation
|
||||||
|
|
||||||
|
## Type of Change
|
||||||
|
|
||||||
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||||
|
- [ ] New feature (non-breaking change which adds functionality)
|
||||||
|
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||||
|
- [ ] Documentation update
|
||||||
|
- [ ] Refactoring (no functional changes)
|
||||||
|
- [ ] Tests (adding or updating tests)
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
- [ ] Go tests pass (`make test`)
|
||||||
|
- [ ] Frontend tests pass (`cd ui && npm test`)
|
||||||
|
- [ ] E2E tests pass (`make e2e`)
|
||||||
|
- [ ] Manual testing completed
|
||||||
|
- [ ] Tested on multiple platforms (if applicable)
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] My code follows the project's style guidelines
|
||||||
|
- [ ] I have performed a self-review of my own code
|
||||||
|
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||||
|
- [ ] I have made corresponding changes to the documentation
|
||||||
|
- [ ] My changes generate no new warnings
|
||||||
|
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||||
|
- [ ] New and existing unit tests pass locally with my changes
|
||||||
|
- [ ] Any dependent changes have been merged and published
|
||||||
|
|
||||||
|
## Screenshots (if applicable)
|
||||||
|
|
||||||
|
Add screenshots to demonstrate UI changes.
|
||||||
44
CODE_OF_CONDUCT.md
Normal file
44
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
# Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment:
|
||||||
|
|
||||||
|
- Being respectful and inclusive
|
||||||
|
- Welcoming newcomers and helping them get started
|
||||||
|
- Accepting constructive criticism gracefully
|
||||||
|
- Focusing on what is best for the community
|
||||||
|
- Showing empathy towards other community members
|
||||||
|
- Using welcoming and inclusive language
|
||||||
|
- Gracefully accepting differing viewpoints and experiences
|
||||||
|
|
||||||
|
Examples of unacceptable behavior:
|
||||||
|
|
||||||
|
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
- Public or private harassment
|
||||||
|
- Publishing others' private information without explicit permission
|
||||||
|
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all project spaces, and also applies when an individual is representing the project or its community in public spaces.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at snider@lethean.io. All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
|
||||||
45
CONTRIBUTORS.md
Normal file
45
CONTRIBUTORS.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# Contributors
|
||||||
|
|
||||||
|
Thank you to everyone who has contributed to the Mining Platform!
|
||||||
|
|
||||||
|
## Core Team
|
||||||
|
|
||||||
|
| Name | Role | GitHub |
|
||||||
|
|------|------|--------|
|
||||||
|
| Snider | Creator & Maintainer | [@Snider](https://github.com/Snider) |
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
<!-- ALL-CONTRIBUTORS-LIST:START -->
|
||||||
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||||
|
|
||||||
|
## How to Contribute
|
||||||
|
|
||||||
|
We welcome contributions! Please see our [Contributing Guidelines](docs/development/contributing.md) to get started.
|
||||||
|
|
||||||
|
### Types of Contributions
|
||||||
|
|
||||||
|
- **Code**: Bug fixes, new features, performance improvements
|
||||||
|
- **Documentation**: Guides, API docs, translations
|
||||||
|
- **Design**: UI/UX improvements, icons, screenshots
|
||||||
|
- **Testing**: Bug reports, test coverage, E2E tests
|
||||||
|
- **Ideas**: Feature requests, architecture discussions
|
||||||
|
|
||||||
|
### Recognition
|
||||||
|
|
||||||
|
All contributors are recognized in:
|
||||||
|
- This file
|
||||||
|
- Release notes
|
||||||
|
- GitHub's contributors page
|
||||||
|
|
||||||
|
## Adding Yourself
|
||||||
|
|
||||||
|
After your first contribution is merged, add yourself to this file! Use the following format:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
| Your Name | What you contributed | [@username](https://github.com/username) |
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!*
|
||||||
13
README.md
13
README.md
|
|
@ -65,6 +65,15 @@ Manages installation and configuration of:
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
### Docker (Fastest)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run with Docker - no dependencies required
|
||||||
|
docker run -p 9090:9090 ghcr.io/snider/mining:latest
|
||||||
|
|
||||||
|
# Access the dashboard at http://localhost:9090
|
||||||
|
```
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -191,12 +200,16 @@ Example profile:
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
We welcome contributions! Please read our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing Guidelines](docs/development/contributing.md) first.
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
||||||
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
||||||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||||||
5. Open a Pull Request
|
5. Open a Pull Request
|
||||||
|
|
||||||
|
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the list of contributors.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the EUPL-1.2 License - see the [LICENSE](LICENSE) file for details.
|
This project is licensed under the EUPL-1.2 License - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue