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 Contribution Files #3290

Merged
merged 6 commits into from
Jun 10, 2024
Merged

Update Contribution Files #3290

merged 6 commits into from
Jun 10, 2024

Conversation

ndonkoHenri
Copy link
Collaborator

@ndonkoHenri ndonkoHenri commented May 14, 2024

Closes #2797

Tasks

The following are to be created/updated:

  • Bug Report Form
  • Feature request Form
  • Pull request template

GitHub issue Forms is to be used.

Summary by Sourcery

This pull request updates the contribution files by adding new templates for bug reports, feature requests, and pull requests. These changes aim to streamline and standardize the process for reporting issues and submitting pull requests.

  • New Features:
    • Introduced a new bug report form using GitHub issue forms.
    • Introduced a new feature request form using GitHub issue forms.
    • Added a new pull request template to standardize PR submissions.

@ndonkoHenri ndonkoHenri marked this pull request as ready for review June 10, 2024 08:44
Copy link
Contributor

sourcery-ai bot commented Jun 10, 2024

Reviewer's Guide by Sourcery

This pull request updates the contribution files by adding new templates for bug reports, feature requests, and pull requests. The changes are implemented by creating new YAML and Markdown files in the .github/ISSUE_TEMPLATE and .github/PR_TEMPLATE directories, respectively. These templates aim to standardize and streamline the process of reporting bugs, requesting features, and submitting pull requests.

File-Level Changes

Files Changes
.github/ISSUE_TEMPLATE/01_bug_report.yml
.github/ISSUE_TEMPLATE/02_feature_request.yml
Added new issue templates for bug reports and feature requests to standardize the process of reporting issues and requesting features.
.github/PR_TEMPLATE/01_pr_template.md Added a new pull request template to ensure consistency and completeness in pull request submissions.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • 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.

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 @ndonkoHenri - I've reviewed your changes and they look great!

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

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.

.github/ISSUE_TEMPLATE/02_feature_request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/01_bug_report.yml Outdated Show resolved Hide resolved
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings

<!-- - [ ] I have added tests that prove my fix is effective or that my feature works as expected -->
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Commented out test checkbox

The checkbox for adding tests is commented out. If this is intentional, consider adding a note explaining why.

Copy link
Contributor

Choose a reason for hiding this comment

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

:)

ndonkoHenri and others added 3 commits June 10, 2024 10:50
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@FeodorFitsner FeodorFitsner merged commit 97ca54d into main Jun 10, 2024
2 checks passed
@FeodorFitsner FeodorFitsner deleted the contribution branch June 10, 2024 17:15
zrr1999 pushed a commit to zrr1999/flet that referenced this pull request Jul 17, 2024
* bug report: initial commit

* pr template

* feature request template

* create config.yml

* more user-friendly placeholder text in bug_report

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* rename template name

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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.

Update Contribution guide
2 participants