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

refactor: improve double dirname and add more documentation of Open edX #64

Merged
merged 2 commits into from
Dec 13, 2023

Conversation

MaferMazu
Copy link
Contributor

Description

This PR:

  • Improve double dirname

Pass the $levels parameter to the dirname() call instead of using nested dirname() calls (PHP >= 7.0)
| | (Modernize.FunctionCalls.Dirname.Nested)

  • Add more documentation

Additional information

This changes come from common mistakes in WordPress plugins. Mistakes related:

Incorrect "Tested up to" parameter (readme file):
This should be the major version of WordPress that this plugin has been tested on. In the case of new plugins, we require it to be the latest version. This is necessary for plugins to be visible in the repository.
Example: Tested up to: 6.3

...

Failure to disclose third party or external services (readme file):
Any usage of third party services, such as connecting to an external API, needs to be documented in the readme file.

How to document this:
Clearly explain that your plugin is relying on a third party service and under what circumstances.
Provide a link to the service.
Provide a link to the service's terms of use and/or privacy policies.
There is no specific format for this, but please make sure you provide enough info and links to terms of use / privacy policies.

Checklist for Merge

  • Tested in a remote environment
  • Updated documentation
  • Rebased master/main

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 12, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @MaferMazu! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks @MaferMazu

@MaferMazu MaferMazu merged commit 24e76a1 into openedx:main Dec 13, 2023
5 checks passed
@openedx-webhooks
Copy link

@MaferMazu 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants