Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.42 KB

contributing.md

File metadata and controls

27 lines (17 loc) · 1.42 KB
Raw

Contributing

First and foremost, thank you! We appreciate that you want to contribute to cosmic, 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
  2. pnpm run watch start electron app in watch mode.
  3. pnpm run compile build app but for local debugging only.
  4. pnpm run lint lint your code.
  5. pnpm run typecheck Run typescript check.
  6. pnpm run test Run app test.