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: updated package.json content and electron version in build first app guide #37554

Merged
merged 2 commits into from Mar 28, 2023

Conversation

dufipl
Copy link
Contributor

@dufipl dufipl commented Mar 11, 2023

Description of Change

The Building your First App guide states: "Your package.json file should look something like this after initializing your package and installing Electron." then package.json content is shown, but it is not up to date with how it looks now when creating the app by using the commands provided in the guide and the default values. This was corrected by adding:

  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },

which is added by default while npm init. Also bumped the electron version.

Checklist

Release Notes

notes: no-notes

@welcome
Copy link

welcome bot commented Mar 11, 2023

💖 Thanks for opening this pull request! 💖

We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix.

Examples of commit messages with semantic prefixes:

  • fix: don't overwrite prevent_default if default wasn't prevented
  • feat: add app.isPackaged() method
  • docs: app.isDefaultProtocolClient is now available on Linux

Things that will help get your PR across the finish line:

  • Follow the JavaScript, C++, and Python coding style.
  • Run npm run lint locally to catch formatting errors earlier.
  • Document any user-facing changes you've made following the documentation styleguide.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Mar 11, 2023
@dufipl dufipl changed the title Docs: updated package.json content and electron version in build firs… Docs: updated package.json content and electron version in build first app guide Mar 11, 2023
@dufipl dufipl changed the title Docs: updated package.json content and electron version in build first app guide docs: updated package.json content and electron version in build first app guide Mar 11, 2023
@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes and removed new-pr 🌱 PR opened in the last 24 hours labels Mar 11, 2023
@jkleinsc jkleinsc requested a review from erickzhao March 15, 2023 00:26
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

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

Thanks! I think we recommend using exact versions too so we should make the version numbers not use the caret. :)

docs/tutorial/tutorial-2-first-app.md Outdated Show resolved Hide resolved
docs/tutorial/tutorial-2-first-app.md Outdated Show resolved Hide resolved
@dufipl
Copy link
Contributor Author

dufipl commented Mar 18, 2023

@erickzhao thanks for the comment :)
I've removed the carets, could you take another look?

@erickzhao erickzhao added target/23-x-y PR should also be added to the "23-x-y" branch. target/24-x-y PR should also be added to the "24-x-y" branch. labels Mar 24, 2023
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

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

docs: lgtm

Copy link

@electron-docs-reviewer electron-docs-reviewer bot left a comment

Choose a reason for hiding this comment

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

Approving on behalf of the Electron Docs Team

@jkleinsc jkleinsc merged commit 2e1f803 into electron:main Mar 28, 2023
4 checks passed
@welcome
Copy link

welcome bot commented Mar 28, 2023

Congrats on merging your first pull request! 🎉🎉🎉

@release-clerk
Copy link

release-clerk bot commented Mar 28, 2023

No Release Notes

@trop
Copy link
Contributor

trop bot commented Mar 28, 2023

I have automatically backported this PR to "23-x-y", please check out #37742

@trop
Copy link
Contributor

trop bot commented Mar 28, 2023

I have automatically backported this PR to "24-x-y", please check out #37743

@trop trop bot added in-flight/24-x-y merged/24-x-y PR was merged to the "24-x-y" branch and removed target/23-x-y PR should also be added to the "23-x-y" branch. target/24-x-y PR should also be added to the "24-x-y" branch. in-flight/24-x-y labels Mar 28, 2023
@trop trop bot added merged/23-x-y PR was merged to the "23-x-y" branch. and removed in-flight/23-x-y labels Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📓 merged/23-x-y PR was merged to the "23-x-y" branch. merged/24-x-y PR was merged to the "24-x-y" branch semver/patch backwards-compatible bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants