search

honey-team / ufpy

Ufpy (Useful Python) - package for Python with some useful features
https://honey-team.github.io/ufpy-website
MIT License
3 stars 3 forks source link

Add templates for pulls and issues #47

Closed bleudev closed 2 weeks ago

bleudev commented 2 months ago

closes #13

Summary by Sourcery

Add standardized templates for bug reports, feature requests, and pull requests to improve the consistency and clarity of submissions. Configure issue templates to allow blank issues and include contact links for further assistance.

New Features:

Enhancements:

sourcery-ai[bot] commented 2 weeks ago

Reviewer's Guide by Sourcery

This pull request adds GitHub templates for issues and pull requests. It introduces four new files: two issue templates (for bug reports and feature requests), a pull request template, and a configuration file for issue templates.

File-Level Changes

Change Details Files
Added a bug report issue template
  • Included fields for bug description
  • Added a section for code snippet or repository link
  • Included fields for Python version and pip freeze output
 .github/ISSUE_TEMPLATE/bug_report.md
Added a feature request issue template
  • Included a field for feature description
  • Added an optional section for suggested solution
 .github/ISSUE_TEMPLATE/feature_request.md
Added a pull request template
  • Included an optional description field
  • Added an optional TO-DO list section
  • Included a section to reference the issue being closed
 .github/PULL_REQUEST_TEMPLATE.md
Added a configuration file for issue templates
  • Enabled blank issues
  • Added contact links for GitHub Discussions, Discord server, and Telegram channel
 .github/ISSUE_TEMPLATE/config.yml
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.