diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3de467e2a..e81649cb1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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=''`, `user=''`, `passwd=''`). + ```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='', user='') dev.open() # ... ``` @@ -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 `` before posting. + ``` Traceback (most recent call last): ... @@ -57,6 +64,15 @@ If this is related to a specific RPC call or XML, include the relevant details: ``` +## 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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 070b5b408..23d75c3d6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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='', user='') dev.open() # proposed new API usage... ``` diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md index 0c807d774..64ab35985 100644 --- a/.github/ISSUE_TEMPLATE/task.md +++ b/.github/ISSUE_TEMPLATE/task.md @@ -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 ``) +- [ ] No real usernames or passwords (use `` / ``) +- [ ] No SSH keys, tokens, or secrets +- [ ] Any code snippets or logs use placeholder values + ## Additional Context Any other context, references, or considerations. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index badbf5455..5e8b31503 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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`, ``) +- [ ] Log output included in this PR (in comments or CI artifacts) has been scrubbed of credentials + --- ## Testing Matrix