-
Notifications
You must be signed in to change notification settings - Fork 10
Improve PR template with testing and security checklist #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ArmanKumar456
wants to merge
1
commit into
HarshYadav152:main
Choose a base branch
from
ArmanKumar456:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,127 @@ | ||
| ## Description | ||
| <!-- | ||
| ┌─────────────────────────────────────────────────────────────────┐ | ||
| │ │ | ||
| │ 🔐 G S E C U R E — Pull Request Template │ | ||
| │ │ | ||
| │ Security-first password manager · github.com/HarshYadav152 │ | ||
| │ │ | ||
| │ ⚠️ Complete EVERY section before requesting review. │ | ||
| │ Incomplete PRs will be sent back without review. │ | ||
| │ │ | ||
| └─────────────────────────────────────────────────────────────────┘ | ||
| --> | ||
|
|
||
| Please include a summary of the change and which issue is fixed. Include relevant motivation and context. | ||
| ## 📝 Description | ||
|
|
||
| Fixes # (issue number) | ||
| <!-- | ||
| Summarize your changes clearly: | ||
| - What problem does this PR solve? | ||
| - What approach did you take? | ||
| - Any important context reviewers should know? | ||
| --> | ||
|
|
||
| ## Type of change | ||
| Fixes # <!-- issue number, e.g. Fixes #41 --> | ||
|
|
||
| Please delete options that are not relevant. | ||
| --- | ||
|
|
||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
| - [ ] Documentation update | ||
| ## 🏷️ Type of Change | ||
|
|
||
| ## How Has This Been Tested? | ||
| <!-- Check all that apply — delete none, just uncheck what doesn't apply --> | ||
|
|
||
| Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. | ||
| - [ ] 🐛 Bug fix (non-breaking — fixes an issue) | ||
| - [ ] ✨ New feature (non-breaking — adds functionality) | ||
| - [ ] 💥 Breaking change (alters existing behaviour or API contract) | ||
| - [ ] ♻️ Refactor (improves code without changing behaviour) | ||
| - [ ] 🔒 Security fix (patches a vulnerability or hardens auth/encryption) | ||
| - [ ] 🎨 UI / Styling (visual or layout changes only) | ||
| - [ ] 📝 Documentation update | ||
| - [ ] ⚙️ Config / CI / tooling change | ||
|
|
||
| ## Checklist: | ||
| --- | ||
|
|
||
| - [ ] My code follows the style guidelines of this project | ||
| ## 🧪 How Has This Been Tested? | ||
|
|
||
| <!-- Describe every test you ran. Be specific enough that a reviewer can reproduce it. --> | ||
|
|
||
| ### Test Environment | ||
| | | | | ||
| |---|---| | ||
| | **OS** | | | ||
| | **Browser & Version** | | | ||
| | **Node.js Version** | | | ||
|
|
||
| ### Steps to Reproduce / Verify | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| **✅ Expected result:** | ||
|
|
||
| **❌ Result before this PR (for bug fixes):** | ||
|
|
||
| ### Test Coverage | ||
| - [ ] Manually tested end-to-end on local dev | ||
| - [ ] Unit tests added or updated | ||
| - [ ] All existing tests pass locally | ||
| - [ ] No regressions in related features | ||
|
|
||
| --- | ||
|
|
||
| ## 🖼️ Screenshots | ||
|
|
||
| <!-- UI changes: before & after are required. Delete section for logic-only changes. --> | ||
|
|
||
| <details> | ||
| <summary>Click to expand</summary> | ||
|
|
||
| | Before | After | | ||
| |--------|-------| | ||
| | | | | ||
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ## 🔒 Security Checklist (Gsecure-specific) | ||
|
|
||
| - [ ] No vault data, passwords, or auth tokens are logged or exposed | ||
| - [ ] No new API routes added without middleware protection | ||
| - [ ] Encryption / decryption logic is unchanged or explicitly reviewed | ||
| - [ ] No secrets or API keys are hardcoded | ||
| - [ ] User input is validated and sanitised | ||
|
|
||
| --- | ||
|
|
||
| ## ✅ Checklist | ||
|
|
||
| ### Code Quality | ||
| - [ ] I have performed a self-review of my own code | ||
| - [ ] My code follows the style guidelines of this project | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] My changes generate no new warnings (`npm run lint` passes) | ||
| - [ ] No leftover `console.log`, debug code, or commented-out blocks | ||
|
|
||
| ### Testing | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] New and existing unit tests pass locally with my changes | ||
| - [ ] New and existing unit tests pass locally with my changes | ||
|
|
||
| ### Documentation | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] New API endpoints or changed behaviour are documented | ||
|
|
||
| ### PR Hygiene | ||
| - [ ] PR title follows [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `docs:`…) | ||
| - [ ] This PR is focused on a single concern — no unrelated changes bundled in | ||
| - [ ] Branch is up-to-date with `main` | ||
|
|
||
| --- | ||
|
|
||
| ## 👁️ Reviewer Notes | ||
|
|
||
| <!-- Anything the reviewer should focus on, known limitations, or planned follow-ups. --> | ||
|
|
||
| <!-- | ||
| Thank you for contributing to Gsecure 🔐 | ||
| Questions? Reach the maintainer at HarshYadav152@outlook.com | ||
| --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add blank lines around the Test Environment table.
Line 47 violates markdownlint MD058 (
blanks-around-tables). Add an empty line between the heading and table (and keep one after the table) to avoid lint failures.Suggested fix
📝 Committable suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 47-47: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
Source: Linters/SAST tools