Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 2.83 KB

Atlassify Contributing Guide

Hi, we're really excited that you're interested in contributing to Atlassify!

Before submitting your contribution, please read through the following guide.

Project Philosophy

This project is a tool for monitoring new notifications from Atlassian.

Installation

To get started, you'll need to clone the repository and install the dependencies.

pnpm install

Development

To watch for changes (webpack) in the src directory:

pnpm watch

To run the electron app:

pnpm start

To reload the app with the changes that pnpm watch has detected, you can use the CmdOrCtrl+R shortcut.

Tests

There are 2 checks:

  1. linter & formatter with biome
  2. unit tests with jest
# Run biome to check linting and formatting
pnpm lint:check

# Run unit tests with coverage
pnpm test

# If you want to pass arguments to jest (or other `pnpm` commands)
# like `--watch`, you can prepend `--` to the command
pnpm test -- --watch

# Or if you want to update jest snapshots
pnpm test -- -u

Releases

The release process is automated. Follow the steps below.

  1. Verify that all features you want targeted in the release have been merged to main.
  2. Check the Renovate Dependency Dashboard to see if there are any updates you want included.
  3. Create a new draft release. Set the tag version to something with the format of v1.2.3. Save as a draft before moving to the next step
  4. Create a branch that starts with release/vX.X.X (ie. release/v1.2.3). In this branch you need to:
  • Run pnpm version <new-version-number to bump the version of the app.
  • Commit these changes and open a PR. A GitHub Actions workflow will build, sign and upload the release assets for each commit to that branch as long as a branch is named like release/vX.X.X and there is a draft release with the same version number(package.json).
  1. Merge your release branch into main.
  2. Publish the release once you've finalized the release notes and confirmed all assets are there.
  3. Edit current Milestone to have:
    • description: link to the release notes
    • due date: date of release
    • close milestone
  4. Create a New Milestone for upcoming release.