Skip to content

pull_request_template.md

Latest commit

 

History

History
141 lines (96 loc) · 3.43 KB

pull_request_template.md

File metadata and controls

141 lines (96 loc) · 3.43 KB
name Pull Request
about Submit a pull request to SecOpsDash
title
labels
assignees

📝 Description

Please include a summary of the changes and the related issue.

Fixes # (issue)

🎯 Type of Change

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
  • 🎨 Style/UI change
  • ♻️ Code refactoring
  • ⚡ Performance improvement
  • 🧪 Test update

🚀 Changes Made

What changes have you made? Please provide details.

📸 Screenshots (if applicable)

Add screenshots to show the changes (especially for UI changes)

Before:

[Add screenshot or N/A]

After:

[Add screenshot or N/A]

🧪 Testing

How has this been tested?

  • Unit tests
  • Integration tests
  • Manual testing
  • Browser testing (Chrome, Firefox, Safari, Edge)
  • Mobile testing (iOS, Android)

Test Configuration:

  • OS: [e.g. macOS 14]
  • Browser: [e.g. Chrome 118]
  • Node version: [e.g. 18.17.0]

✅ Checklist

Before submitting your PR, please review and check all of the following:

Code Quality

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings or errors
  • 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

Documentation

  • I have made corresponding changes to the documentation
  • I have updated the CHANGELOG.md (if applicable)
  • I have added JSDoc comments for new functions
  • I have updated the README (if applicable)

Functionality

  • My changes do not break existing functionality
  • I have tested my changes on multiple browsers
  • I have tested my changes on mobile devices (if UI-related)
  • I have verified the changes work with demo data
  • I have considered edge cases and error handling

Git

  • I have rebased my branch on the latest main
  • My commits are atomic and have descriptive messages
  • I have followed the conventional commits format
  • I have resolved all merge conflicts

🔗 Related Issues/PRs

Link any related issues or pull requests:

  • Related to #
  • Closes #
  • Depends on #

📊 Performance Impact

Does this change affect performance?

  • No performance impact
  • Improves performance
  • May impact performance (please explain)

If yes, please provide details:

🔒 Security Considerations

Does this change have security implications?

  • No security implications
  • Improves security
  • May have security implications (please explain)

If yes, please describe:

🌍 Breaking Changes

Does this introduce breaking changes?

  • No
  • Yes (please describe below)

If yes, please describe the breaking changes and migration path:

💬 Additional Notes

Add any additional notes, questions, or context for reviewers:

🙏 Acknowledgments

Credit any contributors, resources, or inspirations:

Thank you for contributing to SecOpsDash! 🛡️

Your contribution helps make security operations better for everyone.