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

Add Readme section for 3rd party software #658

Closed
wants to merge 1 commit into from

Conversation

jmarx
Copy link
Collaborator

@jmarx jmarx commented May 11, 2024

Description of the Change

Add a section in the readme dedicated to giving credit to third party software integrations.

Closes #610
Can be added to @carstingaxion #653
I also created a pr off of @carstingaxion 's branch:
#657 (closed for now

Credits

Props @carstingaxion , @mauteri

Copy link

what-the-diff bot commented May 11, 2024

PR Summary

  • Addition of third-party libraries section in README file
    The README file of our project has been updated with a section listing the external libraries that our project uses. These libraries include Moment.js (for handling dates and times), Moment-Timezone (for timezone specifics), Playwright (for testing), along with React-Modal, and React-Tooltip (functionality for our user interface). This update will make it easier for anyone who's working with or studying our code to understand what third-party resources we rely on.

Copy link
Collaborator

@stephenerdelyi stephenerdelyi left a comment

Choose a reason for hiding this comment

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

Do we need to add the following?

  • Google Maps: Used to render maps - only when Google Maps is selected as your mapping platform.
  • Open Street Map: Used to render maps - only when Open Street Map is selected as your mapping platform.

@jmarx
Copy link
Collaborator Author

jmarx commented May 11, 2024

Do we need to add the following?

  • Google Maps: Used to render maps - only when Google Maps is selected as your mapping platform.
  • Open Street Map: Used to render maps - only when Open Street Map is selected as your mapping platform.

@stephenerdelyi I was going to add OSM as part of our OSM feature. I'm not sure if we need to add google maps since we are just iframing their map. What do you think @mauteri ? Also, does anyone know why the a php unit test would be failing on a simple readme change?

@carstingaxion
Copy link
Collaborator

Also, does anyone know why the a php unit test would be failing on a simple readme change?

@jmarx the logs know the answer, "they" said:

Could not connect to deb.debian.org:80 (146.75.94.132), connection timed out

Should probably work on the next run.

@jmarx
Copy link
Collaborator Author

jmarx commented May 13, 2024

@mauteri Are we good to merge this? Or should we add the map items?

@carstingaxion
Copy link
Collaborator

I added all the changes also to #653 .


- [Moment.js](https://momentjs.com/): Used for date and time manipulation.
- [Moment-Timezone](https://momentjs.com/timezone/): Adds timezone support to Moment.js.
- [Playwright](https://playwright.dev/): Enables browser automation for testing and interaction.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not needed here as it is not packaged with the plugin


This plugin leverages the following third-party libraries for various functionalities:

- [Moment.js](https://momentjs.com/): Used for date and time manipulation.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not needed as it's a WordPress external dependency.

@mauteri
Copy link
Contributor

mauteri commented May 18, 2024

Closing this PR as this should be done in @carstingaxion's PR at this point.

@mauteri mauteri closed this May 18, 2024
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.

WP.ORG: Undocumented use of a 3rd Party or external service
4 participants