Skip to content
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

Update CONTRIBUTING.md #1716

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

wwzeng1
Copy link

@wwzeng1 wwzeng1 commented Jul 26, 2023

Hi! This PR was copied from sweepai-dev#3 generated by https://github.com/sweepai/sweep

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.

Fixes #1505

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding detailed description to issues
2 participants