GitHub Code Workflow

Knack doesn't have an out-of-the-box way to version control the custom CSS and JS that can be added through the Knack builder interface. Therefore, DTS builders have designed the following workflow to version control this custom code using GitHub.

Knack Customizations for Devs

Recording of Dev meeting about Knack Customization. Presentation slides here.

Collaboration Environment (Dev & Apps)

Make sure staging code matches production branch - if not, someone has code that's not deployed

1st Step

Create feature branch off master branch

• Name branch: (Initials_Issue#_Feature_description)

• Test in Knack test environment

• Commit changes to Github

Commit messages: are like change logs, says what the commit does, e.g. "Add big button to home page"

2nd Step

Create pull request (PR) to master branch

• Assign a reviewer

• Link the PR to an issue. See Github docs.OncComment on PR

3rd Step

Once code is reviewed:

• Copy code to Knack production environment

• Test it

• Merge pull request