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

Create pull_request_template.md #125

Merged
merged 1 commit into from
Aug 15, 2024
Merged

Create pull_request_template.md #125

merged 1 commit into from
Aug 15, 2024

Conversation

ryansurf
Copy link
Owner

@ryansurf ryansurf commented Aug 15, 2024

#124

Summary by Sourcery

Add a pull request template to guide contributors in following project guidelines, ensuring code quality, and updating documentation and tests as necessary.

New Features:

  • Introduce a pull request template to standardize the submission process for contributors.

Copy link
Contributor

sourcery-ai bot commented Aug 15, 2024

Reviewer's Guide by Sourcery

This pull request adds a new file named 'pull_request_template.md' in the '.github' directory. The file contains a template for pull requests, which includes a checklist of items for contributors to verify before submitting their pull requests. The template covers general guidelines, code-related checks, and documentation updates.

File-Level Changes

Files Changes
.github/pull_request_template.md Added a new pull request template with a checklist for contributors
.github/pull_request_template.md Included general checks for following contributing guidelines and avoiding duplicate pull requests
.github/pull_request_template.md Added code-related checks for passing tests, running linter/formatter, and writing new tests
.github/pull_request_template.md Included checks for updating documentation and explaining changes

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@ryansurf ryansurf merged commit d6613db into main Aug 15, 2024
8 checks passed
@ryansurf ryansurf deleted the ryansurf-pr-template branch August 15, 2024 18:48
Copy link
Contributor

Coverage

Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
   api.py139795%37–41, 59, 81–82, 114–115
   art.py9367%32–33, 36
   cli.py250100% 
   dev_streamlit.py37370%1–86
   gpt.py10640%16–21, 32–45
   helper.py1223770%116, 127–131, 209–217, 229, 242–243, 274–275, 299–300, 363–373, 380–388
   send_email.py24240%5–48
   server.py471079%55, 68–71, 87–91, 103–105
   settings.py220100% 
   streamlit_helper.py33330%5–90
TOTAL46815766% 

Tests Skipped Failures Errors Time
11 0 💤 0 ❌ 0 🔥 21.493s ⏱️

Copy link
Contributor

@sourcery-ai sourcery-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.

Hey @ryansurf - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@@ -0,0 +1,15 @@
General:

* [ ] Have you followed the guidelines in our [Contributing](https://github.com/ryansurf/cli-surf/blob/main/CONTRIBUTING.md) document?
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (documentation): Consider using an absolute URL for the Contributing document link

While the relative link works within GitHub, an absolute URL ensures the link is functional in all contexts.

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.

1 participant