Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.78 KB
Raw

Contributing to the Pet Store Demo

For general contribution and community guidelines, please see the community repo.

Prerequisites

Before getting started, you should install some developer tools.

  1. git to manage source code
  2. Docker to manage dependencies and runtime environments

Building

Run ./bin/build. Requires Docker.

Testing

To test against a specific database type, run ./test/test {db type}, where db type is mysql, postgres, or mssql.

Releasing

  • Update the VERSION
  • Update the CHANGELOG
  • Submit your changes in a PR
  • Once the PR has been reviewed and merged, at a git tag to the repo
  • Add a github release for the new tag, and copy/paste the CHANGELOG data for the version into the gh release notes

Contributing

  1. Fork the project
  2. Clone your fork
  3. Make local changes to your fork by editing files
  4. Commit your changes
  5. Push your local changes to the remote server
  6. Create new Pull Request

From here your pull request will be reviewed and once you've responded to all feedback it will be merged into the project. Congratulations, you're a contributor!