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.

Sign up for GitHub

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

Jump to bottom

[DRAFT] Adding guidelines for raising issues #3

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

[DRAFT] Adding guidelines for raising issues #3

wants to merge 1 commit into from

Conversation

sweep-ai[bot]
Copy link

@sweep-ai sweep-ai bot commented Jul 26, 2023

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!

Fixes #1.

To checkout this PR branch, run the following command in your terminal:

git checkout sweep/add-issue-guidelines

@sweep-ai sweep-ai bot added the sweep Assigns Sweep to an issue or pull request. label Jul 26, 2023
sweep-ai[bot]
sweep-ai bot commented Jul 26, 2023
View reviewed changes
Copy link
Author

@sweep-ai sweep-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No changes required. The added section "Guidelines for Raising Issues" in CONTRIBUTING.md provides clear instructions for creating new issues, which will be helpful for contributors. Also, the addition of a newline at the end of the file is a good practice to follow. Good job!

@sweep-ai sweep-ai bot mentioned this pull request Jul 26, 2023
Open
@wwzeng1 wwzeng1 mentioned this pull request Jul 26, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
sweep Assigns Sweep to an issue or pull request.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Sweep: Adding detailed description to issues
0 participants