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

Main #841

Closed
wants to merge 1 commit into from
Closed

Main #841

wants to merge 1 commit into from

Conversation

27piyus
Copy link

@27piyus 27piyus commented Nov 28, 2024

Hopefully, this will help improve the quality of new-contirbutor pull
requests to this project.

This pull request addresses the issue with the importlib-metadata dependency in the zulip_bots project. The dependency was missing for Python >= 3.10, causing import errors. I have updated the setup.py file to ensure that the importlib-metadata package is conditionally included for Python versions < 3.10, ensuring compatibility.

Fixes:
This PR fixes the issue #829, where importlib_metadata was being imported in Python >= 3.10 without being listed as a required dependency.

No visual changes were made. The functionality was tested by running the bot with Python 3.10, and the error no longer occurs.

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

Hopefully, this will help improve the quality of new-contirbutor pull
requests to this project.

<!-- Describe your pull request here.-->
This pull request addresses the issue with the importlib-metadata dependency in the zulip_bots project. The dependency was missing for Python >= 3.10, causing import errors. I have updated the setup.py file to ensure that the importlib-metadata package is conditionally included for Python versions < 3.10, ensuring compatibility.

Fixes: <!-- Issue link, or clear description.-->
This PR fixes the issue zulip#829, where importlib_metadata was being imported in Python >= 3.10 without being listed as a required dependency.

<!-- If the PR changes output, always include screenshots or code blocks to demonstrate your changes. If it seems helpful, add a screen capture of the new functionality as well.

Tooling tips: https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html
-->

No visual changes were made. The functionality was tested by running the bot with Python 3.10, and the error no longer occurs.

<details>
<summary>Self-review checklist</summary>

<!-- Prior to submitting a PR, follow our step-by-step guide to review your own code:
https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code -->

<!-- Once you create the PR, check off all the steps below that you have completed.
If any of these steps are not relevant or you have not completed, leave them unchecked.-->

- [ ] [Self-reviewed](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code) the changes for clarity and maintainability
      (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

- [ ] Explains differences from previous plans (e.g., issue description).
- [ ] Highlights technical choices and bugs encountered.
- [ ] Calls out remaining decisions and concerns.
- [ ] Automated tests verify logic where appropriate.

Individual commits are ready for review (see [commit discipline](https://zulip.readthedocs.io/en/latest/contributing/commit-discipline.html)).

- [ ] Each commit is a coherent idea.
- [ ] Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

- [ ] Visual appearance of the changes.
- [ ] Responsiveness and internationalization.
- [ ] Strings and tooltips.
- [ ] End-to-end functionality of buttons, interactions and flows.
- [ ] Corner cases, error conditions, and easily imagined bugs.
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants