Add contribution guidelines & pull request template

[ngundotra]

Important

Add a pull request template and contributing guide to standardize contributions and ensure quality control.

• New Files:
  • Adds PULL_REQUEST_TEMPLATE.md for standardizing PR submissions.
  • Adds CONTRIBUTING.md to guide contributors on project standards.
• PR Template:
  • Sections for description, type of change, screenshots, testing, related issues, checklist, and additional notes.
• Contributing Guide:
  • Instructions for setting up the development environment and starting the server.
  • Detailed testing requirements for protocol integrations, including UI testing and best practices.
  • CI/CD requirements and workflow details.
  • Bug reporting guidelines for security and non-security issues.
  • Step-by-step pull request process and code style guidelines.

^{This description was created by for 9a5daf5. It will automatically update as commits are pushed.}

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
explorer	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 4, 2025 8:36pm

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 9a5daf5 in 1 minute and 5 seconds

More details

• Looked at 272 lines of code in 2 files
• Skipped 0 files when reviewing.
• Skipped posting 7 drafted comments based on config settings.

1. .github/PULL_REQUEST_TEMPLATE.md:9

• Draft comment:
  Checklist items are clear and well-formatted.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

2. .github/PULL_REQUEST_TEMPLATE.md:34

• Draft comment:
  The checklist is comprehensive. Consider if any additional checks (e.g., accessibility tests) are needed.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

3. CONTRIBUTING.md:142

• Draft comment:
  Review the disclosure email and bug bounty link to ensure they are up-to-date and correct.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
  This comment is asking the PR author to ensure that certain information is up-to-date and correct, which falls under the rule of not asking the author to double-check things. It doesn't provide a specific code suggestion or point out a specific issue.

4. CONTRIBUTING.md:169

• Draft comment:
  The embedded PR description template is clear – excellent inclusion for consistency.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

5. .github/PULL_REQUEST_TEMPLATE.md:42

• Draft comment:
  The PR template is clear and thorough. Consider adding an optional prompt for indicating breaking changes or migration needs, which can help reviewers quickly assess potential impact.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

6. CONTRIBUTING.md:142

• Draft comment:
  The bug reporting section uses a placeholder URL for the bug bounty form. If an official link is available, please update it to avoid confusion.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

7. CONTRIBUTING.md:156

• Draft comment:
  Consider adding guidelines for commit message formatting in the Pull Request Process section to promote consistency in commit history.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

Workflow ID: wflow_08wzNumcBQbkzo0G

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.