Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.4 KB
Raw

Contributing Guide

Hi! I'm really excited that you are interested in contributing to appy. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Pull Request Guidelines

  • The master branch contains the latest backward compatible changes:

    • new features: bumps the MINOR version
    • bug fixes: bumps PATCH version

  • The v[0-9]+ branch contains the next version changes which are not backward compatible which bumps the MAJOR version.

Development Setup

  • Install asdf and Docker.
  • Run make bootstrap to install Golang and NodeJS.
  • Run make install to install the project dependencies.
  • Run make up to run MySQL/PostgreSQL/ElasticSearch/Redis docker containers.
  • Run make codecheck to run vet/lint.
  • Run make test to run unit tests.

Commit Convention

Commit messages should follow the commit message convention so that changelogs can be automatically generated.

Project Structure

Coming soon.