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: Quick Start | Electron Forge chapter requirements updated #39639

Merged
merged 3 commits into from
Sep 26, 2023

Conversation

NoxFly
Copy link
Contributor

@NoxFly NoxFly commented Aug 24, 2023

Description of Change

Added 2 points for the deploiement chapter with Electron Forge.
These 2 points are required, else the rpmbuild will fail.

  • install rpm (it was not mentionned in the doc)
  • add a non-blank description to the package.json file of your project

Checklist

  • npm test passes
  • relevant documentation, tutorials, templates and examples are changed or added

Notes: none

Added a note to a pre-require of Electron Forge.
Otherwise users will have an error `Cannot make for rpm, the following external binaries need to be installed: rpmbuild`
@welcome
Copy link

welcome bot commented Aug 24, 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 Aug 24, 2023
@NoxFly NoxFly changed the title Nox fly patch 1 Docs: Quick Start | Electron Forge chapter requirements updated. Aug 24, 2023
docs/tutorial/quick-start.md Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Aug 31, 2023
@zcbenz zcbenz changed the title Docs: Quick Start | Electron Forge chapter requirements updated. docs: Quick Start | Electron Forge chapter requirements updated Aug 31, 2023
@electron-cation electron-cation bot added new-pr 🌱 PR opened in the last 24 hours and removed new-pr 🌱 PR opened in the last 24 hours labels Aug 31, 2023
@zcbenz zcbenz merged commit 624ae02 into electron:main Sep 26, 2023
17 of 19 checks passed
@welcome
Copy link

welcome bot commented Sep 26, 2023

Congrats on merging your first pull request! 🎉🎉🎉

@release-clerk
Copy link

release-clerk bot commented Sep 26, 2023

No Release Notes

MrHuangJser pushed a commit to MrHuangJser/electron that referenced this pull request Dec 11, 2023
…tron#39639)

* Update quick-start.md

Added a note to a pre-require of Electron Forge.
Otherwise users will have an error `Cannot make for rpm, the following external binaries need to be installed: rpmbuild`

* Add two required steps for Electron Forge to build without errors

* Update docs/tutorial/quick-start.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

---------

Co-authored-by: Erick Zhao <erick@hotmail.ca>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants