Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 2.19 KB
Raw

Contributing to Stockpot

Thank you so much for your interest in contributing to Stockpot!

Overview

Stockpot is a Rails Engine which means that it's "considered miniature applications that provide functionality to their host applications." It can technically be run on its own via rails s, but it's meant to be run inside a larger app, so running it on its own won't really provide a lot of benefit, or really work correctly at the moment. Think of Stockpot as a helpful addon to an existing Rails app that unlocks a handful of API routes to use, saving time writing them yourself.

The project's repo will look similar to a Rails app, though very pared down. There's an app directory, but inside you'll only find controllers. As Stockpot is just an API that returns JSON, there's no need for views, and, for now, there's also no need for models, so you won't find them there either.

Working with the code

PRs

  • Make sure to update the CHANGELOG with your changes.
    • Please follow the existing Keep a Changelog format
    • Add yourself to the contributors list at the bottom so that attribute links work
    • Attribute the changes you've made to yourself (and others if it was a group effort) by specifying the PR/Issue number(s) and your linked username like this: ([#1](https://github.com/Freshly/stockpot/pull/1) [jaysonesmith])
  • Add tests where applicable! We want to make sure that our changes don't detract from existing functionality and that other's can continue to rely on Stockpot for their needs.

Releases

When changes on Master need to be released, the following steps should be followed, assuming you have release privileges.

  • Update the version number in version.rb
  • Run bundle so that the Gemfile.lock gets updated.
  • Run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org. Remember to use the MAJOR.MINOR.PATCH formatting of Semantic Versioning

Who