Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.87 KB
Raw

Contributing to the Amplitude SDK for Node

🎉 Thanks for your interest in contributing! 🎉

Ramping Up

PR Commit Title Conventions

PR titles should follow conventional commit standards. This helps automate the release process.

Commit Types (related to release conditions)

  • Special Case: Any commit with BREAKING CHANGES in the body: Creates major release
  • feat(<optional scope>): New features (minimum minor release)
  • fix(<optional scope>): Bug fixes (minimum patch release)
  • perf(<optional scope>): Performance improvement
  • docs(<optional scope>): Documentation updates
  • test(<optional scope>): Test updates
  • refactor(<optional scope>): Code change that neither fixes a bug nor adds a feature
  • style(<optional scope>): Code style changes (e.g. formatting, commas, semi-colons)
  • build(<optional scope>): Changes that affect the build system or external dependencies (e.g. Yarn, Npm)
  • ci(<optional scope>): Changes to our CI configuration files and scripts
  • chore(<optional scope>): Other changes that don't modify src or test files
  • revert(<optional scope>): Revert commit

Release [Amplitude Internal]

Releases are managed by semantic-release. It is a tool that will scan commits since the last release, determine the next semantic version number, publish, and create changelogs.

Release Conditions [Amplitude Internal]

  • BREAKING CHANGES in the body will do a major release 
    feat(cookies): Create new cookie format

BREAKING CHANGES: Breaks old cookie format
  • Else feat in title will do a minor release feat(cookies): some changes
  • Else fix or perf in title will do a patch release fix: null check bug
  • Else no release docs: update website