38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
# Contributing to arcline-check
|
|
|
|
This project is maintained by one person. Contributions are welcome — please read this first.
|
|
|
|
## Reporting bugs
|
|
|
|
Open an issue with:
|
|
- What you did
|
|
- What you expected
|
|
- What happened instead
|
|
- OS, Go version, and any relevant config
|
|
|
|
## Suggesting features
|
|
|
|
Open an issue before writing code. A quick discussion saves everyone time — not every feature fits the scope of this tool.
|
|
|
|
## Submitting a pull request
|
|
|
|
1. Fork the repo and create a branch from `main`
|
|
2. Keep changes focused — one fix or feature per PR
|
|
3. If adding a feature, update the README to reflect it
|
|
4. Make sure it compiles and existing behavior still works
|
|
5. Open the PR with a clear description of what it does and why
|
|
|
|
## Code style
|
|
|
|
- Standard Go formatting (`gofmt`)
|
|
- No external dependencies without a good reason
|
|
- Prefer clear over clever
|
|
|
|
## What gets merged
|
|
|
|
This is a small project with a specific scope. PRs that fix real bugs or add clearly useful features will be merged. PRs that add complexity without clear benefit probably won't — no hard feelings.
|
|
|
|
## License
|
|
|
|
By submitting a pull request, you agree that your contribution will be licensed under the same license as this project.
|