CONTRIBUTING.md

Contributing to Spinup Host

Thanks for your interest in improving the project! This document provides a step-by-step guide for general contributions to Spinup.

Communications

We have a slack, join using the invite link.

Submitting a PR

If you have a specific idea of a fix or update, follow these steps below to submit a PR:

• Contributing to Spinup Host
  • Communications
  • Submitting a PR
    • Step 1: Make the change
    • Step 2: Start Spinup locally
    • Step 3: Commit and push your changes
    • Step 4: Create a pull request
    • Step 5: Get a code review

Step 1: Make the change

1. Fork the Spinup repo, and then clone it:

   export user={your github profile name}
   git clone [email protected]:${user}/spinup.git

2. Set your cloned local to track the upstream repository:

   cd spinup
   git remote add upstream https://github.com/spinup-host/spinup

3. Disable pushing to upstream master:

   git remote set-url --push upstream no_push
   git remote -v

   The output should look like:

   origin    [email protected]:$(user)/spinup.git (fetch)
   origin    [email protected]:$(user)/spinup.git (push)
   upstream  https://github.com/spinup-host/spinup (fetch)
   upstream  no_push (push)

4. Get your local master up-to-date and create your working branch:

   git fetch upstream
   git checkout master
   git rebase upstream/master
   git checkout -b myfeature

Step 2: Compile and start the Spinup API server locally

make run-api

NB: Run make help on your terminal to see the full list of make commands.

Step 3: Hack and make your changes!

Step 4: Commit, sync and test your changes

1. Run the following commands to keep your branch in sync:

   git fetch upstream
   git rebase upstream/master

2 Run these commands to validate your changes.

make test
make checks

Making a Pull Request

Pull request are welcome. For major changes, please open an issue first to discuss what you would like to do.