mirror of
https://github.com/LmeSzinc/StarRailCopilot.git
synced 2024-09-28 06:45:03 +00:00
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# Contributing
|
||
|
||
First and foremost, thank you! We appreciate that you want to contribute to vite-electron-builder, your time is
|
||
valuable, and your contributions mean a lot to us.
|
||
|
||
## Issues
|
||
|
||
Do not create issues about bumping dependencies unless a bug has been identified, and you can demonstrate that it
|
||
effects this library.
|
||
|
||
**Help us to help you**
|
||
|
||
Remember that we’re here to help, but not to make guesses about what you need help with:
|
||
|
||
- Whatever bug or issue you're experiencing, assume that it will not be as obvious to the maintainers as it is to you.
|
||
- Spell it out completely. Keep in mind that maintainers need to think about _all potential use cases_ of a library.
|
||
It's important that you explain how you're using a library so that maintainers can make that connection and solve the
|
||
issue.
|
||
|
||
_It can't be understated how frustrating and draining it can be to maintainers to have to ask clarifying questions on
|
||
the most basic things, before it's even possible to start debugging. Please try to make the best use of everyone's time
|
||
involved, including yourself, by providing this information up front._
|
||
|
||
## Repo Setup
|
||
|
||
The package manager used to install and link dependencies must be npm v7 or later.
|
||
|
||
1. Clone repo
|
||
1. `npm run watch` start electron app in watch mode.
|
||
1. `npm run compile` build app but for local debugging only.
|
||
1. `npm run lint` lint your code.
|
||
1. `npm run typecheck` Run typescript check.
|
||
1. `npm run test` Run app test.
|
||
1. `npm run format` Reformat all codebase to project code style.
|