added PR template

[kristinmerbach]

Summary by CodeRabbit

• Documentation
  • Introduced a PR checklist template to enhance compliance with submission guidelines for contributors.
  • Added details for PR types, ticket information, behavior changes, feature flags, and additional context.
  • Included protocol for handling AppScan CodeSweep failures.

[coderabbitai]

Walkthrough

The recent update introduces a new Pull Request (PR) template in the project's GitHub repository. This template outlines checklist items for contributors, PR types, ticket details, behavior changes, feature flags, and provides additional context along with the AppScan CodeSweep failure protocol.

Changes

File Path	Change Summary
.github/PULL_REQUEST_TEMPLATE.md	Introduced a comprehensive PR template with detailed guidelines

🐇✨
A template fresh, in GitHub's realm,
Guides contributions at the helm.
Checklists clear, for all to see,
Ensuring code's as it should be.
Hop, hop, hurray, for structured PRs today! 🎉
🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 4

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (2)

.github/PULL_REQUEST_TEMPLATE.md (2)

6-6: Consider rephrasing to clarify the use of "let helpers and before blocks" in tests.

Perhaps specify that these are related to RSpec testing practices for clarity.

---

17-52: Consider using secondary headings (##) for sub-sections under the main heading.

This helps in maintaining a clear structure and improves the readability of the document.

[saikumar9]

@markgoho @kristinmerbach Please review my comment.

[saikumar9]

@kristinmerbach @polographer AppScan CodeSweep Failure is not applicable for Fdsh GW.