Skip to content

Commit 4fef7a6

Browse files
docs(oss-prep): add CODE_OF_CONDUCT.md + CONTRIBUTING.md (community-profile completion)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 3c6f38e commit 4fef7a6

5 files changed

Lines changed: 143 additions & 1 deletion

File tree

CODE_OF_CONDUCT.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Code of conduct
2+
3+
InstaNode is a small, focused engineering community. We want everyone who participates — issue reporters, PR authors, reviewers, maintainers — to feel safe and respected.
4+
5+
## Expectations
6+
7+
- Be respectful in code review and issues. Critique code, not people.
8+
- Assume good intent. Ask questions before making accusations.
9+
- Keep discussions on topic. Off-topic and inflammatory threads will be closed.
10+
- No harassment, personal attacks, discriminatory language, or unwelcome sexual attention.
11+
12+
## Enforcement
13+
14+
Maintainers may close issues, lock threads, edit comments, or block accounts that violate these expectations.
15+
16+
## Reporting
17+
18+
Email security@instanode.dev to report a concern. We treat reports confidentially. We aim to respond within 72 hours.
19+
20+
## Scope
21+
22+
These expectations apply to all project spaces — issues, pull requests, discussions, and any official InstaNode communication channel — and to public spaces when someone is representing the project.
23+
24+
This policy is intentionally short; we will lengthen it as the community grows.

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to the InstaNode CLI
2+
3+
## Filing issues
4+
5+
Bugs and feature requests welcome at https://github.com/InstaNode-dev/cli/issues.
6+
7+
## Workflow
8+
9+
```
10+
git clone https://github.com/InstaNode-dev/cli
11+
cd cli
12+
go build ./...
13+
go vet ./...
14+
go test ./... -short -p 1
15+
```
16+
17+
All three must pass before opening a PR.
18+
19+
## Local testing
20+
21+
```
22+
go run ./cmd/instanode --help
23+
go run ./cmd/instanode up
24+
```
25+
26+
Set `INSTANODE_API_URL=http://localhost:8080` to point at a local api instance.
27+
28+
## Style
29+
30+
- Follow existing patterns. Help strings are user-visible — keep them tight.
31+
- New flags get a one-line `--help` description and a test that exercises the success + error path.
32+
- Errors returned to the user should include a one-line agent_action hint matching the api's structured error envelope (see api/internal/handlers/helpers.go for the registry).
33+
34+
## PR checklist
35+
36+
- `go build ./...` green
37+
- `go vet ./...` green
38+
- `go test ./... -short -p 1` green
39+
- Help-text changes mirrored in README if user-visible
40+
- New command added: include a unit test + a README example
41+
42+
## License
43+
44+
MIT. By contributing, you agree your contributions are licensed under the same.

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 InstaNode
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.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Zero-friction infrastructure CLI for [instanode.dev](https://instanode.dev).
55
## Install
66

77
```bash
8-
go install github.com/instant-dev/cli@latest
8+
go install github.com/InstaNode-dev/cli@latest
99
```
1010

1111
## Usage

SECURITY.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Security Policy
2+
3+
We take the security of the InstaNode CLI seriously. Thank you for helping
4+
keep our users and infrastructure safe.
5+
6+
## Reporting a Vulnerability
7+
8+
Please report suspected security issues by email to **security@instanode.dev**.
9+
10+
Include as much of the following as you can:
11+
12+
- A description of the vulnerability and its impact.
13+
- Steps to reproduce, ideally a minimal proof of concept.
14+
- The affected version, commit SHA, or release tag.
15+
- Any suggested remediation.
16+
17+
We aim to acknowledge new reports within **2 business days** and to provide
18+
a substantive response (triage outcome, severity, expected timeline) within
19+
**7 business days**.
20+
21+
Please do **not** open a public GitHub issue, pull request, or discussion
22+
for suspected vulnerabilities until a fix is available and we have agreed
23+
on a coordinated disclosure date.
24+
25+
## Scope
26+
27+
In scope:
28+
29+
- The CLI binary and source in this repository (`github.com/InstaNode-dev/cli`).
30+
- Authentication flows used by the CLI (device-code login, token storage,
31+
keyring integration).
32+
- Any code path that handles user credentials, API tokens, or secrets.
33+
34+
Out of scope:
35+
36+
- Vulnerabilities in third-party dependencies (please report upstream; we
37+
will pick up patched versions promptly).
38+
- Issues that require a pre-compromised local machine (full local user
39+
account compromise, malicious OS packages, etc.).
40+
- Findings that depend on running custom or modified builds of the CLI.
41+
- Social engineering of InstaNode staff or users.
42+
43+
## Safe Harbor
44+
45+
We will not pursue or support legal action against researchers who:
46+
47+
- Make a good-faith effort to comply with this policy.
48+
- Avoid privacy violations, destruction of data, and disruption of service.
49+
- Only interact with accounts they own or have explicit permission to access.
50+
- Give us a reasonable opportunity to remediate before public disclosure.
51+
52+
If in doubt, email **security@instanode.dev** before testing — we are happy
53+
to scope a test plan with you.

0 commit comments

Comments
 (0)