Skip to content

Commit c583c18

Browse files
TheSmallPixelclaude
andcommitted
docs: add LICENSE and community files
Adds MIT license (Lorenzo Longiave), contributing guide, GitHub issue templates (bug report + feature request), and PR template. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d1cc27f commit c583c18

5 files changed

Lines changed: 119 additions & 0 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Something isn't working as expected
4+
title: ''
5+
labels: bug
6+
---
7+
8+
**Describe the bug**
9+
A clear description of what's wrong.
10+
11+
**Reproduce**
12+
1. ...
13+
2. ...
14+
15+
**Expected behavior**
16+
What you expected to happen.
17+
18+
**Environment**
19+
- .NET version:
20+
- Action version (tag or commit):
21+
- Runner OS:
22+
23+
**Workflow snippet**
24+
```yaml
25+
# the `with:` block you used
26+
```
27+
28+
**Additional context**
29+
Logs, screenshots of the rendered graph, links.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea
4+
title: ''
5+
labels: enhancement
6+
---
7+
8+
**The problem**
9+
What pain are you hitting today?
10+
11+
**Proposed solution**
12+
What would you like to see?
13+
14+
**Alternatives considered**
15+
Other approaches you've thought about.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## What
2+
3+
<!-- One-line summary of the change -->
4+
5+
## Why
6+
7+
<!-- Motivation: bug fixed, feature added, refactor reasoning -->
8+
9+
## Checklist
10+
11+
- [ ] Tests added or updated
12+
- [ ] `dotnet build` and `dotnet test` pass locally
13+
- [ ] `CHANGELOG.md` updated under `[Unreleased]` if user-visible
14+
- [ ] No tracked artifacts (`bin/`, `obj/`, `.DS_Store`, editor backups)

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing
2+
3+
Thanks for taking the time. PRs and issues are welcome.
4+
5+
## Setup
6+
7+
You need the [.NET 8 SDK](https://dotnet.microsoft.com/download).
8+
9+
```bash
10+
git clone https://github.com/TheSmallPixel/GraphCSharp
11+
cd GraphCSharp
12+
dotnet build tools/CodeAnalysisTool
13+
dotnet test tools/CodeAnalysisTool.Tests
14+
```
15+
16+
## Running locally
17+
18+
The analyzer is a standalone CLI:
19+
20+
```bash
21+
dotnet run --project tools/CodeAnalysisTool -- <source-path> <docs-dir>
22+
```
23+
24+
Open `<docs-dir>/index.html` in a browser to view the graph.
25+
26+
## Pull requests
27+
28+
- Keep changes focused — one concern per PR.
29+
- Add or update a test in `tools/CodeAnalysisTool.Tests` for any behavior change.
30+
- Run `dotnet test` locally before pushing.
31+
- Conventional prefixes (`fix:`, `feat:`, `docs:`, `refactor:`, `test:`, `chore:`) are appreciated.
32+
33+
## Reporting bugs
34+
35+
Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md). Include
36+
the .NET version, the action invocation, and a minimal repro if possible.
37+
38+
## Code of conduct
39+
40+
This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Lorenzo Longiave
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)