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

feat: [FC-0074] add linter for Open edX Filters classes definitions #480

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Jan 13, 2025

Description:

This PR adds a custom linter for Open edX Filter classes docstrings to check whether new filters follow the specified format:

        Description:
        Filter used to modify the certificate rendering process.
        ... (more description)
        Filter Type:
            org.openedx.learning.certificate.render.started.v1
        Trigger:
            - Repository: openedx/edx-platform
            - Path: lms/djangoapps/certificates/views/webview.py
            - Function or Method: render_html_view

If a class is missing at least one of the section, then a pylint error is raised:

image

You can see the linter integrated into the repo in this PR: openedx/openedx-filters#249

I'm open to moving this directly into the openedx-filters repo if needed, considering that the linter is kind of specific to that repository.

Merge checklist:

  • All reviewers approved
  • CI build is green
  • If adding new checks, followed how_tos/0001-adding-new-checks.rst
  • Changelog record added (if needed)
  • Documentation updated (not only docstrings) (if needed)
  • Commits are squashed

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

openedx-webhooks commented Jan 13, 2025

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/axim-engineering.

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.

@mariajgrimaldi mariajgrimaldi changed the title feat: add linter for openedx-filters classes definitions feat: [FC-0074] add linter for openedx-filters classes definitions Jan 13, 2025
@mariajgrimaldi mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Jan 13, 2025
@mariajgrimaldi mariajgrimaldi changed the title feat: [FC-0074] add linter for openedx-filters classes definitions feat: [FC-0074] add linter for Open edX Filters classes definitions Jan 13, 2025
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review January 13, 2025 12:40
@mariajgrimaldi mariajgrimaldi requested a review from sarina January 13, 2025 12:40
@sarina
Copy link
Contributor

sarina commented Jan 13, 2025

I'm open to moving this directly into the openedx-filters repo if needed, considering that the linter is kind of specific to that repository.

I pinged the Axim eng team in slack to see if anyone has an opinion on this - I don't, but I'm not a primary maintainer of this repo.

@mariajgrimaldi
Copy link
Member Author

Thank you, @sarina!

I'll tag @openedx/axim-engineering here as the owners according to the catalog-info.yaml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

3 participants