Skip to content

Commit da77f23

Browse files
blue4209211claude
blue4209211
and
claude
authored
docs+chore: README cleanup + OSS-readiness scaffolding (#75)
README: - Replace nonexistent `nbctl traces list` section with the real `nbctl traces query` command, including all flags. - Add `nbctl integrations` section (added in PR #73 but undocumented). - Add Contributing / Security / License sections at the bottom pointing at the new top-level files. OSS hygiene: - LICENSE — Apache 2.0 (matches the rest of the Nudgebee project). - CODE_OF_CONDUCT.md — Contributor Covenant 2.x. - CONTRIBUTING.md — adapted from the monorepo template for this single-Go-module repo (dev setup, Makefile targets, commit conventions, PR guidelines). - SECURITY.md — vulnerability reporting policy and response timeline. - .github/pull_request_template.md — standard template. - .github/ISSUE_TEMPLATE/{BUG-REPORT,FEATURE-REQUEST,config}.yml — CLI-flavored (asks for `nbctl version`, install method, OS/arch instead of web-only fields). - .github/dependabot.yml — weekly gomod + github-actions updates. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent eb0d886 commit da77f23

10 files changed

Lines changed: 735 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: "🐛 Bug Report"
2+
description: Report a bug in nbctl.
3+
title: "🐛 [BUG] - <title>"
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: "Description"
11+
description: A clear and concise description of the bug.
12+
placeholder: What happened? What did you expect to happen?
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: reprod
18+
attributes:
19+
label: "Reproduction steps"
20+
description: Exact commands and inputs that reproduce the bug.
21+
value: |
22+
1. Run `nbctl ...`
23+
2. Observe error / unexpected output
24+
render: bash
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: actual
30+
attributes:
31+
label: "Actual output"
32+
description: The output you saw. Include the full error message and stack trace if any.
33+
render: bash
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: expected
39+
attributes:
40+
label: "Expected output"
41+
description: What you expected to see.
42+
validations:
43+
required: false
44+
45+
- type: input
46+
id: version
47+
attributes:
48+
label: "nbctl version"
49+
description: "Output of `nbctl version`."
50+
placeholder: e.g. nbctl version 0.1.0
51+
validations:
52+
required: true
53+
54+
- type: dropdown
55+
id: install
56+
attributes:
57+
label: "Install method"
58+
description: How did you install nbctl?
59+
multiple: false
60+
options:
61+
- Released binary (GitHub release)
62+
- go install
63+
- Built from source
64+
- Other (please mention in description)
65+
validations:
66+
required: true
67+
68+
- type: dropdown
69+
id: os
70+
attributes:
71+
label: "OS"
72+
description: Operating system where the bug occurred.
73+
multiple: false
74+
options:
75+
- macOS
76+
- Linux
77+
- Windows
78+
validations:
79+
required: true
80+
81+
- type: dropdown
82+
id: arch
83+
attributes:
84+
label: "Architecture"
85+
multiple: false
86+
options:
87+
- amd64
88+
- arm64
89+
- other
90+
validations:
91+
required: true
92+
93+
- type: textarea
94+
id: logs
95+
attributes:
96+
label: "Verbose logs"
97+
description: |
98+
Re-run the failing command with `--verbose` and paste the
99+
relevant section of `nbctl_graphql.log`. Redact any
100+
sensitive values (account IDs, tokens, hostnames).
101+
render: bash
102+
validations:
103+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "💡 Feature Request"
2+
description: Propose a new feature or command for nbctl.
3+
title: "💡 [REQUEST] - <title>"
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: "Summary"
11+
description: One-paragraph explanation of the feature.
12+
placeholder: What should nbctl do that it can't do today?
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: motivation
18+
attributes:
19+
label: "Motivation / use case"
20+
description: |
21+
What workflow does this enable? What are you doing today as
22+
a workaround?
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: proposed_command
28+
attributes:
29+
label: "Proposed command shape"
30+
description: |
31+
If applicable, what would the command look like? Include
32+
flags, arguments, and example output.
33+
value: |
34+
```bash
35+
nbctl <command> <args> [flags]
36+
```
37+
render: markdown
38+
validations:
39+
required: false
40+
41+
- type: textarea
42+
id: alternatives
43+
attributes:
44+
label: "Alternatives considered"
45+
description: Other approaches you considered and why you rejected them.
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: references
51+
attributes:
52+
label: "References"
53+
description: Related issues, PRs, or external docs.
54+
validations:
55+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "gomod"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"

‎.github/pull_request_template.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List
4+
any dependencies that are required for this change.
5+
6+
Fixes # (issue)
7+
8+
## Type of change
9+
10+
Please delete options that are not relevant.
11+
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] Enhancement (non-breaking change which adds functionality)
14+
- [ ] Refactor (non-breaking change which improves code structure)
15+
- [ ] Documentation (non-breaking change which improves documentation)
16+
- [ ] Performance (non-breaking change which improves performance)
17+
- [ ] Chore (non-breaking change which does not modify src or test files)
18+
- [ ] Build / CI (non-breaking change which does not modify src or test files)
19+
- [ ] Security (non-breaking change which improves security)
20+
- [ ] New feature (non-breaking change which adds functionality)
21+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
22+
23+
# How Has This Been Tested?
24+
25+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
26+
list any relevant details for your test configuration
27+
28+
- [ ] Test A
29+
- [ ] Test B

‎CODE_OF_CONDUCT.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
7+
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to a positive environment for our community include:
13+
14+
* Demonstrating empathy and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
19+
20+
Examples of unacceptable behavior include:
21+
22+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
23+
* Trolling, insulting or derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others' private information, such as a physical or email address, without their explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Enforcement Responsibilities
29+
30+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
31+
32+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
33+
34+
## Scope
35+
36+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
37+
38+
## Enforcement
39+
40+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at legal@nudgebee.com. All complaints will be reviewed and investigated promptly and fairly.
41+
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
## Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
### 1. Correction
49+
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53+
54+
### 2. Warning
55+
56+
**Community Impact**: A violation through a single incident or series of actions.
57+
58+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59+
60+
### 3. Temporary Ban
61+
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65+
66+
### 4. Permanent Ban
67+
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69+
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
75+
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
77+
78+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
79+
80+
[homepage]: https://www.contributor-covenant.org
81+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
82+
[Mozilla CoC]: https://github.com/mozilla/diversity
83+
[FAQ]: https://www.contributor-covenant.org/faq
84+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)