search

sweepai-dev / convoy

Open Source Webhooks Gateway; For both incoming & outgoing events.
https://getconvoy.io
Mozilla Public License 2.0
0 stars 0 forks source link

Sweep: Adding detailed description to issues #1

Open wwzeng1 opened 1 year ago

wwzeng1 commented 1 year ago

We need to add more details and context when raising issue. This will improve and foster contributions.

sweep-ai[bot] commented 1 year ago

Here's the PR! https://github.com/sweepai-dev/convoy/pull/3.

💎 Sweep Pro: I used GPT-4 to create this ticket. You have 4 GPT-4 tickets left.

Step 1: 🔍 Code Search

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description. https://github.com/sweepai-dev/convoy/blob/15444ec907f7ab4921c4a44d241279b3e5356112/CONTRIBUTING.md#L1-L47 https://github.com/sweepai-dev/convoy/blob/15444ec907f7ab4921c4a44d241279b3e5356112/CHANGELOG.md#L1-L452 https://github.com/sweepai-dev/convoy/blob/15444ec907f7ab4921c4a44d241279b3e5356112/web/components/app-portal-vue/src/lib-components/convoy-app.vue#L665-L737

Step 2: 🧐 Snippet Analysis

From looking through the relevant snippets, I decided to make the following modifications:

File Path Proposed Changes
CONTRIBUTING.md Add a new section titled "Guidelines for Raising Issues". In this section, explain the importance of providing detailed descriptions when raising issues. Include a template for users to follow when creating new issues, prompting them to provide a clear and concise title, a detailed description of the issue, steps to reproduce the issue, expected and actual results, and any relevant error messages or logs.

Step 3: 📝 Planning

I have created a plan for writing the pull request. I am now working my plan and coding the required changes to address this issue. Here is the planned pull request:

Adding guidelines for raising issues sweep/add-issue-guidelines

Description

This PR adds guidelines for raising issues to the CONTRIBUTING.md file. The new guidelines provide instructions on how to provide detailed descriptions when raising issues, improving the quality and clarity of the issues raised.

Changes Made

  • Added a new section titled "Guidelines for Raising Issues" to the CONTRIBUTING.md file.
  • Included instructions on providing a clear and concise title, a detailed description of the issue, steps to reproduce the issue, expected and actual results, and any relevant error messages or logs.
  • Added a template for users to follow when creating new issues.

Checklist

  • [ ] Updated the CONTRIBUTING.md file with the new guidelines.
  • [ ] Tested the changes locally to ensure they work as expected.
  • [ ] Verified that the new guidelines are clear and easy to follow.

Please review and merge this PR once the changes have been approved. Thank you!

Step 4: ⌨️ Coding

I have finished coding the issue. I am now reviewing it for completeness.

Step 5: 🔁 Code Review

Success! 🚀

I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind! Join Our Discord