Skip to content

Commit e149f61

Browse files
docs: rename repo URLs and restructure README for OSS (#142)
- Rename repo references from intility/Intility.JsonApiToolkit to intility/json-api-toolkit - Restructure README in Intility OSS style - Tighten documentation - Drop GitHub Packages install instructions in favor of dotnet add package - Closes #98
1 parent a1d296d commit e149f61

36 files changed

Lines changed: 761 additions & 1950 deletions

.github/CODEOWNERS

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
# Default owner for everything
21
* @erlendellefsen
3-
4-
# Security-sensitive files require extra review
5-
.github/workflows/** @erlendellefsen

.github/ISSUE_TEMPLATE/1-basic-issue.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ description: File a basic issue.
33
type: Task
44
projects: ['intility/56']
55
body:
6-
- type: markdown
7-
attributes:
8-
value: |
9-
Thanks for taking the time to fill out this issue!
106
- type: textarea
117
attributes:
128
label: What's the issue?

.github/ISSUE_TEMPLATE/2-feature_request.yml

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,17 @@ labels: ['enhancement']
44
type: Feature
55
projects: ['intility/56']
66
body:
7-
- type: markdown
8-
attributes:
9-
value: |
10-
Thanks for taking the time to request a new feature or enhancement. Please fill out the form below to help us understand your request.
117
- type: textarea
128
id: feature-request
139
attributes:
1410
label: Feature request
15-
description: Please describe the feature you would like to see.
16-
placeholder: I would like to see...
11+
description: What would you like to see?
1712
validations:
1813
required: true
1914
- type: textarea
2015
id: use-case
2116
attributes:
2217
label: Use case
23-
description: Please describe the use case for this feature.
24-
placeholder: This feature would be useful for...
25-
validations:
26-
required: false
27-
- type: dropdown
28-
id: priority
29-
attributes:
30-
label: Priority
31-
description: Please select the priority of this feature request.
32-
options:
33-
- Low
34-
- Medium
35-
- High
36-
default: 2
18+
description: What problem does this solve? Why is the current behavior insufficient?
3719
validations:
3820
required: true

.github/ISSUE_TEMPLATE/3-bug-report.yml

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,38 @@ labels: ['bug']
44
type: Bug
55
projects: ['intility/56']
66
body:
7-
- type: markdown
8-
attributes:
9-
value: |
10-
Thanks for taking the time to fill out this bug report!
117
- type: textarea
128
id: what-happened
139
attributes:
1410
label: What happened?
15-
description: Also tell us, what did you expect to happen?
16-
placeholder: Tell us what you see!
17-
value: 'A bug happened!'
11+
description: What did you observe, and what did you expect instead?
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: repro
16+
attributes:
17+
label: Steps to reproduce
18+
description: Minimal repro steps. Code snippet, request, or test case if possible.
19+
render: csharp
1820
validations:
1921
required: true
20-
- type: dropdown
21-
id: browsers
22+
- type: input
23+
id: toolkit-version
2224
attributes:
23-
label: What browsers are you seeing the problem on?
24-
multiple: true
25-
options:
26-
- Firefox
27-
- Chrome
28-
- Safari
29-
- Microsoft Edge
25+
label: JsonApiToolkit version
26+
placeholder: e.g. 2.1.0
27+
validations:
28+
required: true
29+
- type: input
30+
id: dotnet-version
31+
attributes:
32+
label: .NET version
33+
placeholder: e.g. 10.0
34+
validations:
35+
required: true
3036
- type: textarea
3137
id: logs
3238
attributes:
33-
label: Relevant log output
34-
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
39+
label: Relevant logs
40+
description: Optional. Paste relevant log output. Formatting is automatic.
3541
render: shell

.github/codeql/codeql-config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: "JsonApiToolkit CodeQL"
2+
3+
paths-ignore:
4+
- "**/bin/**"
5+
- "**/obj/**"

.github/dependabot.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ updates:
1414
commit-message:
1515
prefix: "build(nuget)"
1616
groups:
17-
# Group minor/patch updates to reduce PR noise
1817
microsoft:
1918
patterns:
2019
- "Microsoft.*"

.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Summary
2+
3+
<!-- What does this change and why? -->
4+
5+
## Related issues
6+
7+
<!-- Closes #123, Refs #456 -->

.github/workflows/codeql.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ name: CodeQL
22

33
on:
44
schedule:
5-
- cron: "0 6 * * 1" # Monday 6am UTC
5+
- cron: "0 6 * * 1"
6+
workflow_dispatch:
67

78
concurrency:
89
group: ${{ github.workflow }}-${{ github.ref }}
@@ -32,6 +33,7 @@ jobs:
3233
with:
3334
languages: csharp
3435
queries: security-and-quality
36+
config-file: ./.github/codeql/codeql-config.yml
3537

3638
- name: Restore
3739
run: dotnet restore --locked-mode

.github/workflows/release-please.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3
2222
id: app-token
2323
with:
24-
app-id: ${{ vars.RELEASE_BOT_APP_ID }}
24+
client-id: ${{ vars.RELEASE_BOT_APP_ID }}
2525
private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
2626

2727
- uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ Set `"JsonApiToolkit": "Debug"` in appsettings.json to enable detailed query pro
1717
- **Pagination clamping**: Invalid page numbers are silently clamped (negative/zero -> page 1, overflow -> last page).
1818
- **Malformed query params**: Bad filter/sort/include syntax is logged and skipped, not thrown as exceptions.
1919
- **Filtered includes**: Dot notation in filters (e.g. `filter[author.name]=John`) applies to included resources when `include=author` is also set.
20-
- **Include whitelisting**: `AllowedIncludesAttribute` on controller actions restricts which relationships can be requested via `include=`, preventing unauthorized data exposure.
20+
- **Include allowlisting**: `AllowedIncludesAttribute` on controller actions restricts which relationships can be requested via `include=`, preventing unauthorized data exposure.
2121
- **Sparse fieldsets**: `fields[type]=field1,field2` works for both primary and included resources. `id` and `type` are always returned.

0 commit comments

Comments
 (0)