add contributing and license
This commit is contained in:
37
CONTRIBUTING.md
Normal file
37
CONTRIBUTING.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
# Contributing to arcline-audit
|
||||||
|
|
||||||
|
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.
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 Arcline IT
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -32,3 +32,7 @@ arcline-audit example.com --out report.txt
|
|||||||
| Infrastructure | ASN/org, CDN detection, common open ports |
|
| Infrastructure | ASN/org, CDN detection, common open ports |
|
||||||
|
|
||||||
See [todo.md](todo.md) for the full task list and output format spec.
|
See [todo.md](todo.md) for the full task list and output format spec.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT — see [LICENSE](LICENSE).
|
||||||
|
|||||||
Reference in New Issue
Block a user