Skip to content
This repository has been archived by the owner on Apr 14, 2023. It is now read-only.

Latest commit

 

History

History
65 lines (44 loc) · 1.46 KB

CONTRIBUTION.md

File metadata and controls

65 lines (44 loc) · 1.46 KB

How to contribute 🌟

I'm really happy you're reading this.😄 Thanks for taking the time to contribute!👍

  • Pomodoro Logger's roadmap is shown on the issue page
  • If you find a bug or want a new feature, create an issue
  • If you want to work on an issue, comment on it to let me know

Development

This project is built by Electron.

You only need to install the latest version of node.js and node-gyp to build this project.

Issue the following commands to make sure you are ready to go,

yarn
yarn build
yarn test

Start development 💻

yarn start
// within another terminal
npx electron .
  • If you are using windows10 install bash shell for running above commands

If you are in China, there may be a connection problem when setting things up.

Before running yarn, issue

ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/"

Alternatively, you can add the following lines to .npmrc and .yarnrc files.

# ~/.npmrc
registry=https://registry.npm.taobao.org
electron_mirror=https://npm.taobao.org/mirrors/electron/

and

# ~/.yarnrc
registry "https://registry.npm.taobao.org"
electron_mirror "https://npm.taobao.org/mirrors/electron/"

Coding Conventions

  • Don't use independent CSS file, use styled-component instead
  • Follow the linter