Skip to content

Latest commit

 

History

History
104 lines (68 loc) · 2.95 KB

README.md

File metadata and controls

104 lines (68 loc) · 2.95 KB
Raw

Gatsby Remotely Tailwind Starter

code style: prettier

INITIALIZATION

Install Gatsby Remotely Tailwind Starter as your project

Please note that Gatsby CLI (npm install -g gatsby-cli) should be installed on your system in order to run gatsby commands.

  1. Clone this repo to create your project and navigate to it (replace my-project with something telling)
$ git clone https://github.com/arnars/gatsby-remotely-tailwind-starter/ my-project && cd my-project

  1. Create new repository on our GitHub page called my-project

  2. Modify package.json to fit your needs.

  3. Install project dependencies

$ npm
  1. Make your first commit
$ git add :/ -A && git commit -m "First commit"
  1. Push to master
$ git push origin master
  1. Branch out and start developing
$ git checkout -b my-branch && npm run dev

DEVELOPING

Install

  1. Clone the repo, then install the required node modules using npm.
$ git clone https://github.com/arnars/my-project.git && cd my-project && npm install
  1. Branch out and start developing
$ git checkout -b my-branch && npm run dev

Branching

Branching is inspired by Gitlab Flow.

A few pointers:

  1. Feature branches (commits), Master branch (PR) and Production branch (PR)
  2. Always do work using feature branches, no direct commits on master or production
  3. Always perform code reviews via pull requests before rebasing onto master
  4. Always delete feature branches after rebasing onto master
  5. Pushed commits are never rebased
  6. Everyone starts from master, and targets master
  7. Fix bugs in master first then rebase via pull request to production
  8. Do not use a GUI for your git'ing, unless you are certain that the above is possible to do

Commit messages

Commit messages is based on The Seven Rules of a Great Commit Message

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

The above 7 rules should always be applied. If working on anything that is not a feature, please use one of the following commit type prefixes:

Commit types
  • [fix] (bug fix)
  • [docs] (changes to documentation)
  • [cleanup] (removal of obsolete files or code)
  • [refactor] (refactoring production code)
  • [chore] (updating gulp tasks etc; linting)

E.g. [chore] Versioning

When committing features, omit any prefix and just write a telling subject line.

Amending

Do not ever amend a commit that has been pushed public. Otherwise feel free.