Skip to content

Commit cccbe41

Browse files
dominicbachmanndominicbachmann
committed
chore: add governance and community health files
1 parent 3fc6d8a commit cccbe41

9 files changed

Lines changed: 782 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/01-bug_report.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
name: Bug report
2+
description: Report a bug or unexpected behavior in an OpenNG library
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
type: Bug
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug.
12+
13+
**Please do not report security vulnerabilities here.** Use the appropriate private disclosure channel for your project.
14+
15+
Issues without a minimal reproduction are difficult to triage and may be closed. Provide a StackBlitz or GitHub repo that demonstrates the problem.
16+
17+
- type: checkboxes
18+
id: checklist
19+
attributes:
20+
label: Checklist
21+
options:
22+
- label: I have searched the existing issues and have not found a duplicate
23+
required: true
24+
- label: I have read the README and documentation and have not found a solution
25+
required: true
26+
- label: I agree to follow the [OpenNG Foundation Code of Conduct](https://github.com/openng-foundation/.github/blob/main/CODE_OF_CONDUCT.md)
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: What happened?
33+
description: A clear and concise description of the bug.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: steps
39+
attributes:
40+
label: Steps to reproduce
41+
description: Detailed steps to reproduce the behavior.
42+
placeholder: |
43+
1. ...
44+
2. ...
45+
3. ...
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: expected
51+
attributes:
52+
label: Expected behavior
53+
description: What you expected to happen.
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: actual
59+
attributes:
60+
label: Actual behavior
61+
description: What actually happened.
62+
validations:
63+
required: true
64+
65+
- type: input
66+
id: repro-url
67+
attributes:
68+
label: Minimal reproduction
69+
description: Link to a StackBlitz, GitHub repo, or other minimal repro.
70+
placeholder: https://stackblitz.com/... or https://github.com/...
71+
validations:
72+
required: true
73+
74+
- type: input
75+
id: library-version
76+
attributes:
77+
label: Library version
78+
placeholder: e.g. 1.2.3
79+
validations:
80+
required: true
81+
82+
- type: input
83+
id: angular-version
84+
attributes:
85+
label: Angular version
86+
placeholder: e.g. 19.0.0
87+
validations:
88+
required: true
89+
90+
- type: input
91+
id: node-version
92+
attributes:
93+
label: Node version
94+
placeholder: e.g. 22.0.0
95+
validations:
96+
required: true
97+
98+
- type: dropdown
99+
id: package-manager
100+
attributes:
101+
label: Package manager
102+
options:
103+
- npm
104+
- pnpm
105+
- yarn
106+
- bun
107+
validations:
108+
required: true
109+
110+
- type: dropdown
111+
id: browsers
112+
attributes:
113+
label: Browser(s)
114+
multiple: true
115+
options:
116+
- Chrome
117+
- Edge
118+
- Firefox
119+
- Safari
120+
- Opera
121+
- Other
122+
validations:
123+
required: true
124+
125+
- type: textarea
126+
id: environment
127+
attributes:
128+
label: Environment details
129+
description: OS and other relevant environment information.
130+
value: |
131+
- OS:
132+
- Node:
133+
- Package manager:
134+
render: markdown
135+
136+
- type: dropdown
137+
id: angular-setup
138+
attributes:
139+
label: Angular application setup
140+
options:
141+
- Standalone components
142+
- NgModule-based
143+
- Both / mixed
144+
- Not sure
145+
146+
- type: checkboxes
147+
id: angular-context
148+
attributes:
149+
label: Angular context
150+
options:
151+
- label: SSR (Server-Side Rendering) is involved
152+
- label: Zoneless change detection is enabled
153+
154+
- type: textarea
155+
id: logs
156+
attributes:
157+
label: Relevant log output
158+
description: Console errors, stack traces, or terminal output.
159+
render: shell
160+
161+
- type: upload
162+
id: screenshots
163+
attributes:
164+
label: Screenshots
165+
description: If applicable, add screenshots to help explain the problem.
166+
validations:
167+
accept: .png,.jpg,.jpeg,.gif,.webp
168+
169+
- type: textarea
170+
id: additional-context
171+
attributes:
172+
label: Additional context
173+
description: Any other information that might help us investigate.

‎.github/ISSUE_TEMPLATE/02-feature_request.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement for an OpenNG library
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
type: Feature
7+
body:
8+
- type: checkboxes
9+
id: checklist
10+
attributes:
11+
label: Checklist
12+
options:
13+
- label: I have searched the existing issues and have not found a duplicate
14+
required: true
15+
- label: I have read the README and documentation
16+
required: true
17+
- label: I agree to follow the [OpenNG Foundation Code of Conduct](https://github.com/openng-foundation/.github/blob/main/CODE_OF_CONDUCT.md)
18+
required: true
19+
20+
- type: textarea
21+
id: problem
22+
attributes:
23+
label: Problem
24+
description: What problem does this feature solve? What is your use case?
25+
placeholder: I'm always frustrated when...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: solution
31+
attributes:
32+
label: Proposed solution
33+
description: A clear and concise description of what you want to happen.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: api-sketch
39+
attributes:
40+
label: Proposed API or usage
41+
description: If applicable, provide a TypeScript API sketch or usage example.
42+
render: typescript
43+
44+
- type: textarea
45+
id: alternatives
46+
attributes:
47+
label: Alternatives considered
48+
description: Any alternative solutions or workarounds you have considered.
49+
50+
- type: dropdown
51+
id: priority
52+
attributes:
53+
label: How important is this feature to you?
54+
options:
55+
- "Nice to have"
56+
- Important
57+
- Critical
58+
validations:
59+
required: true
60+
61+
- type: checkboxes
62+
id: willing-to-pr
63+
attributes:
64+
label: Contribution
65+
options:
66+
- label: I am willing to open a pull request for this feature
67+
68+
- type: textarea
69+
id: additional-context
70+
attributes:
71+
label: Additional context
72+
description: Screenshots, mockups, links, or other supporting information.

‎.github/ISSUE_TEMPLATE/03-documentation.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Documentation
2+
description: Report missing, outdated, or confusing documentation
3+
title: "[Docs]: "
4+
labels:
5+
- documentation
6+
type: Task
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for helping improve our documentation. If you intend to submit a fix, mention it below — pull requests are welcome.
12+
13+
- type: checkboxes
14+
id: docs-type
15+
attributes:
16+
label: Documentation is
17+
options:
18+
- label: Missing
19+
- label: Outdated
20+
- label: Confusing
21+
- label: Typo or formatting error
22+
- label: Not sure
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: docs-location
28+
attributes:
29+
label: Documentation location
30+
description: URL or file path to the page or section.
31+
placeholder: https://www.openng.org/docs/... or docs/getting-started.md
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: details
37+
attributes:
38+
label: What is wrong or missing?
39+
description: Describe the issue and what you expected to find.
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: suggestion
45+
attributes:
46+
label: Suggested improvement
47+
description: Proposed fix or new content. If you plan to open a PR, describe the change here.
48+
validations:
49+
required: true
50+
51+
- type: upload
52+
id: screenshots
53+
attributes:
54+
label: Screenshots
55+
description: If applicable, upload screenshots showing incorrect or confusing documentation.
56+
validations:
57+
accept: .png,.jpg,.jpeg,.gif,.webp
58+
59+
- type: checkboxes
60+
id: will-submit-pr
61+
attributes:
62+
label: Contribution
63+
options:
64+
- label: I plan to submit a pull request for this documentation fix

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: OpenNG Foundation
4+
url: https://www.openng.org/
5+
about: Visit the OpenNG Foundation website for project information and resources

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Description
2+
3+
<!-- What changed and why? For bug fixes, describe before/after behavior. -->
4+
5+
## Related issues
6+
7+
<!-- Link issues this PR addresses, e.g. Fixes #123, Closes #456, or Relates to #789 -->
8+
9+
Fixes #
10+
11+
## Type of change
12+
13+
- [ ] Bug fix (non-breaking change that fixes an issue)
14+
- [ ] New feature (non-breaking change that adds functionality)
15+
- [ ] Breaking change (fix or feature that changes the public API)
16+
- [ ] Documentation only
17+
- [ ] Refactor, test, or chore (no user-facing change)
18+
19+
## Breaking changes
20+
21+
<!-- If this is a breaking change, describe what changed and how consumers should migrate. Otherwise, write "None". -->
22+
23+
None
24+
25+
## Test plan
26+
27+
<!-- How did you verify this change? List commands run and manual steps taken. -->
28+
29+
- [ ] `npm run build`
30+
- [ ] `npm test`
31+
- [ ] `npm run lint`
32+
- [ ] Verified in the demo app (if applicable)
33+
34+
## Checklist
35+
36+
- [ ] Issue discussed or bug clearly described (link issue when applicable)
37+
- [ ] Tests added or updated for behavioral changes
38+
- [ ] Documentation updated (README, JSDoc, migration notes as needed)
39+
- [ ] Public API changes documented; breaking changes called out
40+
- [ ] CHANGELOG updated (if the repository maintains one and the change is user-facing)
41+
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
42+
- [ ] I agree to follow the [OpenNG Foundation Code of Conduct](https://github.com/openng-foundation/.github/blob/main/CODE_OF_CONDUCT.md)
43+
44+
## Additional context
45+
46+
<!-- Screenshots, StackBlitz links, SSR/zoneless notes, or anything else reviewers should know. -->

‎.github/dependabot.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Dependabot version updates for OpenNG Foundation org defaults.
2+
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
3+
4+
version: 2
5+
6+
updates:
7+
- package-ecosystem: github-actions
8+
directory: /
9+
schedule:
10+
interval: weekly
11+
day: monday
12+
open-pull-requests-limit: 5
13+
labels:
14+
- dependencies
15+
commit-message:
16+
prefix: chore
17+
include: scope
18+
19+
- package-ecosystem: npm
20+
directory: /
21+
schedule:
22+
interval: weekly
23+
day: monday
24+
open-pull-requests-limit: 5
25+
labels:
26+
- dependencies
27+
commit-message:
28+
prefix: chore
29+
include: scope
30+
groups:
31+
dev-dependencies:
32+
dependency-type: development
33+
patterns:
34+
- "*"

0 commit comments

Comments
 (0)