Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ A clear and concise description of the bug.

## Steps to Reproduce

> **Security reminder:** Before pasting any code, logs, or output below, replace all
> real hostnames, IP addresses, usernames, and passwords with safe placeholders
> (e.g. `host='<DEVICE-IP>'`, `user='<USERNAME>'`, `passwd='<REDACTED>'`).

```python
# Minimal reproducible example
# Minimal reproducible example — credentials/hostnames already replaced
from jnpr.junos import Device

dev = Device(host='router.example.com', user='admin')
dev = Device(host='<DEVICE-IP>', user='<USERNAME>')
dev.open()
# ...
```
Expand All @@ -33,6 +37,9 @@ What you expected to happen.

What actually happened. Include the full traceback if applicable.

> **Security reminder:** Ensure the traceback/log output below does not contain real
> hostnames, IP addresses, usernames, or passwords. Replace them with `<REDACTED>` before posting.

```
Traceback (most recent call last):
...
Expand All @@ -57,6 +64,15 @@ If this is related to a specific RPC call or XML, include the relevant details:
<!-- RPC request/response if applicable -->
```

## Credential Scrubbing Checklist

Before submitting, confirm you have removed sensitive data from this report:

- [ ] No real hostnames or IP addresses
- [ ] No real usernames
- [ ] No real passwords or SSH key material
- [ ] No real device serial numbers or other PII

## Additional Context

Add any other context, logs, or screenshots about the problem here.
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@ Why is this important to you? Who else might benefit?

Describe how you'd like the feature to work. Include API sketches or usage examples if possible.

> **Security reminder:** Replace any real hostnames, IP addresses, usernames, or passwords
> in code examples with safe placeholders before posting.

```python
# Example of how you'd like to use the new feature
# Example of how you'd like to use the new feature — use placeholder credentials
from jnpr.junos import Device

dev = Device(host='router.example.com', user='admin')
dev = Device(host='<DEVICE-IP>', user='<USERNAME>')
dev.open()
# proposed new API usage...
```
Expand Down
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ Any technical details, constraints, or suggested approach for completing this ta
- Closes #
- Related to #

## Credential & Sensitive Data Reminder

> **Before submitting:** ensure this issue contains no real credentials or sensitive data.

- [ ] No real hostnames or IP addresses (use `<DEVICE-IP>`)
- [ ] No real usernames or passwords (use `<USERNAME>` / `<REDACTED>`)
- [ ] No SSH keys, tokens, or secrets
- [ ] Any code snippets or logs use placeholder values

## Additional Context

Any other context, references, or considerations.
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ sphinx-build -b html docs docs/_build/html -W
- [ ] No hardcoded credentials, IPs, or sensitive data introduced
- [ ] Dependencies in `requirements.txt` updated (if new packages were added)

### Credential & Sensitive Data Scrubbing

- [ ] PR description, comments, and code snippets contain no real hostnames or IP addresses
- [ ] PR description, comments, and code snippets contain no real usernames or passwords
- [ ] No SSH keys, tokens, or secrets appear anywhere in this PR
- [ ] Test fixtures and sample XML/RPC output use placeholder values (e.g. `192.0.2.x`, `<REDACTED>`)
- [ ] Log output included in this PR (in comments or CI artifacts) has been scrubbed of credentials

---

## Testing Matrix
Expand Down
Loading