ryansurf / cli-surf

Get surf and ocean data from the command line interface
MIT License
18 stars 30 forks source link

Create pull_request_template.md #125

Closed ryansurf closed 3 months ago

ryansurf commented 3 months ago

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:

sourcery-ai[bot] commented 3 months ago

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](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
github-actions[bot] commented 3 months ago

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 :zzz: 0 :x: 0 :fire: 21.493s :stopwatch: