Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (64 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

91 lines (64 loc) · 3.01 KB
Raw

Contributing to WeekBox

Thanks for helping improve WeekBox.

Before you start

  • Search existing issues before opening a new one.
  • Describe bugs with the WeekBox version, operating system, expected result, actual result, and reproducible steps.
  • Keep feature requests focused on a clear player or maintainer need.
  • Join the WeekBox Discord Server to discuss development, translations, or other project work.
  • For project work, contact Malloy or Britex through Discord first.

Pull requests

  1. Create a branch from the current default branch.
  2. Keep each pull request focused on one change.
  3. Explain what changed and how you tested it.
  4. Update CHANGELOG.md under Unreleased when the change affects users or contributors.
  5. Do not add secrets, downloaded binaries, unrelated generated files, or malicious code.
  6. Wait for a maintainer review before merging.

By contributing, you agree that your contribution may be distributed under the repository's MIT License.

Changelog

WeekBox follows Keep a Changelog. Add user-facing changes under ## [Unreleased] in CHANGELOG.md using the appropriate section: Added, Changed, Deprecated, Removed, Fixed, or Security.

Keep entries short and describe what changed. Several commits for one change can become one changelog entry.

Commit messages

Use Conventional Commits:

type: short description

Examples:

feat: add nightly build details
fix(downloads): detect the remote file size
docs: update contribution links

Keep commit descriptions short and specific. Useful types include feat, fix, docs, refactor, test, build, and chore.

Write commits like a normal person. Use simple words and do not make a fix sound more technical or important than it is. Prefer fix archive downloads to stabilize archive transfers.

Versions

WeekBox follows Semantic Versioning. Contributors should not change the project version unless a maintainer asks them to. Maintainers decide when a release is made and what version it gets.

Release checklist

Before tagging a release, update all seven items below:

  • package.json
  • package-lock.json: update the root version and packages[""].version
  • neutralino.config.json
  • installer/weekbox.iss
  • packaging/rpm/weekbox.spec
  • CHANGELOG.md: move Unreleased to the dated release and update compare links
  • com.immalloy.weekbox.app.manifest.xml: update version=

Run these checks before tagging:

npm run build
npm run locales:check:strict
git diff --check

Translations

User-facing translations live in app/src/ui/locales/. Keep English strings in en.json and preserve the existing translation keys and placeholders.

Security issues

Do not use public issues or public Discord messages for vulnerabilities that could put users at risk. Contact a project maintainer privately instead.