Skip to content

Commit e1c896c

Browse files
committed
chore: add OSS community health files
Add standard open-source community files to make the project welcoming and contribution-ready: - CONTRIBUTING.md: dev setup, branching strategy, conventional commits, PR process, coding standards, and testing guidelines - CODE_OF_CONDUCT.md: Contributor Covenant v2.0, contact updated - SECURITY.md: responsible disclosure process with maintainer email - .github/ISSUE_TEMPLATE/bug_report.md: structured bug reports with environment, config, and reproduction steps sections - .github/ISSUE_TEMPLATE/feature_request.md: feature proposals with use-case and contribution-willingness fields - .github/PULL_REQUEST_TEMPLATE.md: PR checklist aligned with the project's pre-commit and CI requirements
1 parent 99bc0db commit e1c896c

6 files changed

Lines changed: 455 additions & 0 deletions

File tree

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve music-cli
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of the bug.
12+
13+
## Steps to Reproduce
14+
15+
1. Run `music-cli ...`
16+
2. ...
17+
3. See error
18+
19+
## Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## Actual Behavior
24+
25+
What actually happened (include full error output / stack trace if available).
26+
27+
## Environment
28+
29+
- **OS:** [e.g., macOS 14.4, Ubuntu 22.04, Windows 11]
30+
- **music-cli version:** [run `music-cli --version`]
31+
- **Python version:** [run `python --version`]
32+
- **FFmpeg version:** [run `ffmpeg -version | head -1`]
33+
- **Install method:** [pip / uv / source]
34+
- **Optional extras installed:** [ai / youtube / none]
35+
36+
## Configuration
37+
38+
<details>
39+
<summary>~/.config/music-cli/config.toml (redact any personal info)</summary>
40+
41+
```toml
42+
# paste here
43+
```
44+
45+
</details>
46+
47+
## Additional Context
48+
49+
Add any other context, logs, or screenshots here.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea or improvement for music-cli
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
11+
A clear description of the problem or gap this feature would solve.
12+
*e.g. "I'm a developer who uses focus mode, but I can't quickly switch stations without stopping playback."*
13+
14+
## Proposed Solution
15+
16+
A clear description of what you want to happen.
17+
18+
## Alternatives Considered
19+
20+
Any alternative solutions or workarounds you've thought about.
21+
22+
## Use Cases
23+
24+
Describe specific scenarios where this would be valuable:
25+
26+
1. ...
27+
2. ...
28+
29+
## Would you be willing to contribute this?
30+
31+
- [ ] Yes, I'd like to open a PR for this
32+
- [ ] I can help test / review
33+
- [ ] No, just suggesting
34+
35+
## Additional Context
36+
37+
Any mockups, references to similar tools, or extra context.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Description
2+
3+
Brief description of what this PR changes and why.
4+
5+
## Related Issue
6+
7+
Fixes #<!-- issue number -->
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix (non-breaking)
12+
- [ ] New feature (non-breaking)
13+
- [ ] Breaking change
14+
- [ ] Documentation update
15+
- [ ] Refactoring (no functional change)
16+
- [ ] CI / tooling / chore
17+
18+
## Checklist
19+
20+
- [ ] Code follows the project style guidelines (`pre-commit run --all-files` passes)
21+
- [ ] Self-reviewed the diff
22+
- [ ] Tests added / updated for changed behaviour
23+
- [ ] Documentation updated if behaviour changed (README, docs/, docstrings)
24+
- [ ] CI checks pass
25+
26+
## Testing Done
27+
28+
Describe how you tested the changes:
29+
30+
```bash
31+
# commands you ran
32+
```
33+
34+
## Screenshots / Output (if applicable)
35+
36+
<!-- paste terminal output or screenshots here -->
37+
38+
## Additional Notes
39+
40+
Any context reviewers should know (trade-offs, known issues, follow-up work).

CODE_OF_CONDUCT.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment:
18+
19+
* Demonstrating empathy and kindness toward other people
20+
* Being respectful of differing opinions, viewpoints, and experiences
21+
* Giving and gracefully accepting constructive feedback
22+
* Accepting responsibility and apologizing to those affected by our mistakes
23+
* Focusing on what is best for the overall community
24+
25+
Examples of unacceptable behavior:
26+
27+
* The use of sexualized language or imagery, and sexual attention or advances
28+
* Trolling, insulting or derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate
32+
33+
## Enforcement Responsibilities
34+
35+
Community leaders are responsible for clarifying and enforcing our standards of
36+
acceptable behavior and will take appropriate and fair corrective action in
37+
response to any behavior that they deem inappropriate, threatening, offensive,
38+
or harmful.
39+
40+
## Scope
41+
42+
This Code of Conduct applies within all community spaces, and also applies when
43+
an individual is officially representing the community in public spaces.
44+
45+
## Enforcement
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
48+
reported to the project maintainer at [luongnv89@gmail.com](mailto:luongnv89@gmail.com).
49+
50+
All complaints will be reviewed and investigated promptly and fairly.
51+
52+
## Attribution
53+
54+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
55+
version 2.0, available at
56+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
57+
58+
[homepage]: https://www.contributor-covenant.org

0 commit comments

Comments
 (0)