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

docs(readme): examples use ESM #609

Merged
merged 3 commits into from Feb 24, 2024
Merged

Conversation

oscard0m
Copy link
Member

@oscard0m oscard0m commented Jul 9, 2023

No issue for this doc adjustment


Behavior

Before the change?

code examples in README.md use CommonJS

After the change?

code examples in README.md use ESM


Additional info

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes (Please add the Type: Breaking change label)
  • No

If Yes, what's the impact:

  • N/A

Pull request type

Type: Documentation


@ghost ghost added this to Inbox in JS Jul 9, 2023
@oscard0m oscard0m added the Type: Documentation Improvements or additions to documentation label Jul 9, 2023
@ghost ghost moved this from Inbox to Documentation in JS Jul 9, 2023
@oscard0m oscard0m force-pushed the docs-suggest-esm-as-default-option branch from 6fbf2b0 to 4bfe728 Compare July 9, 2023 08:42
@oscard0m oscard0m requested a review from wolfy1339 July 9, 2023 08:44
@oscard0m oscard0m enabled auto-merge (squash) July 9, 2023 15:41
@gr2m
Copy link
Contributor

gr2m commented Jul 9, 2023

I'm not sure if we should do this? Did we already update the examples in other places? Sorry if I missed a discussion about it

@oscard0m
Copy link
Member Author

oscard0m commented Jul 9, 2023

I'm not sure if we should do this? Did we already update the examples in other places? Sorry if I missed a discussion about it

As far as I know, we have not changed examples in other places and no discussion yet.

I assumed this could be changed because of this #586 but I'm creating the proper discussion to talk about this: octokit/octokit.js#2491

@oscard0m oscard0m marked this pull request as draft July 9, 2023 21:36
auto-merge was automatically disabled July 9, 2023 21:36

Pull request was converted to draft

@wolfy1339 wolfy1339 marked this pull request as ready for review February 24, 2024 18:10
@wolfy1339 wolfy1339 merged commit 10214d9 into main Feb 24, 2024
5 of 6 checks passed
@wolfy1339 wolfy1339 deleted the docs-suggest-esm-as-default-option branch February 24, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
Archived in project
JS
  
Documentation
Development

Successfully merging this pull request may close these issues.

None yet

3 participants