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

chore: Upgrade Requirements #181

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Conversation

Ali-Salman29
Copy link
Contributor

This PR improves the project's linting configuration and updates dependencies:

  • Update dependencies to the newer versions
  • Configured django-settings-module to point to the project settings for proper integration with pylint-django.
  • Addressed compatibility with the newer pylint version, which enforces a limit of 5 positional arguments by default. Added too-many-positional-arguments to the ignore list to accommodate functions exceeding this limit.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 23, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 23, 2025

Thanks for the pull request, @Ali-Salman29!

This repository is currently maintained by @openedx/openedx-unmaintained.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@Ali-Salman29 Ali-Salman29 changed the title Update Requirements chore: Update Requirements Jan 23, 2025
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

Thanks for this PR @Ali-Salman29 ! Please see comments.

pylintrc Outdated Show resolved Hide resolved
requirements/base.txt Outdated Show resolved Hide resolved
requirements/base.txt Outdated Show resolved Hide resolved
requirements/base.txt Outdated Show resolved Hide resolved
- Configured django-settings-module to point to the project settings for proper integration with pylint-django.
- Addressed compatibility with the newer pylint version, which enforces a limit of 5 positional arguments by default. Added too-many-positional-arguments to the ignore list to accommodate functions exceeding this limit.
@Ali-Salman29 Ali-Salman29 force-pushed the alisalman/update-requirements branch from 4a8013b to a5a4aac Compare January 24, 2025 11:20
@Ali-Salman29 Ali-Salman29 changed the title chore: Update Requirements chore: Upgrade Requirements Jan 24, 2025
@Ali-Salman29
Copy link
Contributor Author

@pomegranited thank you for the review. I've updated the dependencies; please review it again.

@Ali-Salman29
Copy link
Contributor Author

@pomegranited, can you please review it?

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 one nit about the pylintrc changes still being there, but the rest looks great, thank you @Ali-Salman29 !

  • I tested this green CI is sufficient
  • Bumps this package's version
  • I read through the code and checked the dependencies updated for breaking changes.

# ------------------------------
[MASTER]
ignore =
persistent = yes
load-plugins = edx_lint.pylint,pylint_django,pylint_celery
django-settings-module = edxsearch.settings
Copy link
Contributor

Choose a reason for hiding this comment

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

Can these changes to pylintrc be reverted?

Copy link
Contributor Author

@Ali-Salman29 Ali-Salman29 Jan 28, 2025

Choose a reason for hiding this comment

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

For local updates, we need to update pylint_tweaks and then run edx_lint write pylintrc to update the pylintrc file. Previously, I updated the file manually, but now it is updated automatically by the command.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok cool, thanks @Ali-Salman29 , I didn't know how that file was maintained :)
Good to merge 👍

@Ali-Salman29 Ali-Salman29 merged commit d94abdd into master Jan 29, 2025
8 checks passed
@Ali-Salman29 Ali-Salman29 deleted the alisalman/update-requirements branch January 29, 2025 10:43
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants