Saltcorn Github Tips

This article attended to new Saltcorn committers and describes how to work with github.

Attention! Article is under development!

How to start develop Saltcorn

  • fork Saltcorn
  • do your work in your favourite IDE
  • update your fork from main Saltcorn repo
  • create pull request to main Saltcorn repo

Fork Saltcorn

You need to be registred user of github.com.

On main page of https://github.com/saltcorn/saltcorn just click to fork button. You will get your own copy of Saltcorn code base.

Do your work in your favourite IDE

Refer to Development of Saltcorn using Windows Subsystem for Linux (WSL) and Visual Studio Code for information how to do it on Windows platform.

Update your fork from main Saltcorn repo

  1. Commit your changes before next activities.

  2. Configure main Saltcorn repo as upstream for your repo accroding Configuring a remote for a fork

$ git remote -v
origin  https://github.com/YOUR_ACCOUNT/saltcorn.git (fetch)
origin  https://github.com/YOUR_ACCOUNT/saltcorn.git (push)

$ git remote add upstream https://github.com/saltcorn/saltcorn.git

$ git remote -v
origin  https://github.com/YOUR_ACCOUNT/saltcorn.git (fetch)
origin  https://github.com/YOUR_ACCOUNT/saltcorn.git (push)
upstream        https://github.com/saltcorn/saltcorn.git (fetch)
upstream        https://github.com/saltcorn/saltcorn.git (push)

  1. Sync your repo with master according Syncing a fork

    git fetch upstream

  2. Merge reposes

git checkout master

git merge upstream/master

git push

Create pull request to main Saltcorn repo

TBD