Skip to content

Contributing

How to report bugs, request features and send patches to Peppermint.

Contributions are welcome. Please read the contributing guide and code of conduct in the repository first.

Ways to help

  • Report a bug or request a feature in the issue tracker.
  • Pick up a good first issue, a bug or a documentation task.
  • Improve these docs and the website.

Development workflow

# 1. Fork and clone
git clone https://github.com/YOUR_FORK/desktop.git
cd desktop

# 2. Create a feature branch
git checkout -b feat/amazing-feature dev

# 3. Make changes and test locally
npm run build:ui && npm start

# 4. Lint and format
npm run lint:fix

# 5. Open a pull request against the `dev` branch

Branch strategy

  • dev is the main development branch.
  • feat/* branches are merged into dev.
  • twilight integrates features for the weekly channel.
  • stable is the release branch and receives hotfixes.
Suggest an improvement