Skip to content

Commit c29c6c2

Browse files
authored
docs: Add CONTRIBUTING.md with contribution guidelines
Added guidelines for contributing to the project, including reporting issues, development setup, code style, commit messages, pull requests, and code of conduct.
1 parent f2480c7 commit c29c6c2

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to scdl.
4+
5+
## Reporting Issues
6+
7+
If you find a bug or have a feature request, please open an issue and include:
8+
9+
- A clear description of the problem
10+
- Steps to reproduce (if applicable)
11+
- Expected vs actual behavior
12+
- Your environment (OS, Go version)
13+
14+
Keep issues focused and reproducible.
15+
16+
## Development Setup
17+
18+
Requirements:
19+
20+
- Go (latest stable version recommended)
21+
22+
Clone the repository:
23+
24+
```bash
25+
git clone git@github.com:hellsontime/scdl.git
26+
cd scdl
27+
go mod tidy
28+
```
29+
30+
Build:
31+
32+
```bash
33+
go build ./...
34+
```
35+
36+
## Code Style
37+
38+
- Follow standard Go formatting (`gofmt`)
39+
- Use clear, explicit error handling
40+
- Avoid unnecessary dependencies
41+
- Keep functions small and focused
42+
- Prefer simple and readable implementations
43+
44+
Before submitting:
45+
46+
```bash
47+
make check
48+
make check-coverage
49+
```
50+
51+
## Commit Messages
52+
53+
This project follows Conventional Commits.
54+
55+
Examples:
56+
57+
- `feat: add progressive stream detection`
58+
- `fix: handle expired signed url`
59+
- `docs: update README usage section`
60+
- `refactor: simplify transcoding resolver`
61+
62+
## Pull Requests
63+
64+
- Keep PRs small and focused
65+
- Describe what changed and why
66+
- Reference related issues if applicable
67+
- Ensure the project builds successfully
68+
69+
## Code of Conduct
70+
71+
By participating in this project, you agree to abide by the Code of Conduct.

0 commit comments

Comments
 (0)