CONTRIBUTING.md

March 4, 2024 ยท View on GitHub

Prerequisites

  • Node.js 16+, Git, Tauri
  • Clone the repository: git clone https://github.com/Levminer/authme
  • Install node modules: npm i
  • Setup project: npm run setup
  • Run start command: npm run dev

Building

  • Prerequisites
  • Run build command: npm run build (You can only build for your own OS)

Contributing rules

  1. Use NPM
  2. Use VS Code
  3. Use ESLint and Prettier
  4. Variable and function names: camelCase
  5. Don't use new npm modules
  6. Make your PR to the dev branch

Notes

  • Create changelog: git log --pretty=format:'* [[%h](https://github.com/Levminer/authme/commit/%h)] %s (%cs)' 3.2.0..HEAD > log.txt