Skip to content

AndreBClark/cosmicdivision

Repository files navigation

Cosmic Division Personal Site

Site https://cosmicdivision.dev

Built With

  • Gatsby The dynamic site generator for dynamic web developers
  • Preact Fast 3kB alternative to React with the same modern API
  • Tailwind CSS utility-first CSS framework that can be composed to build any design, directly in your markup.
  • twin.macro

Contributing

Methods To Clone the project

  • use gh-cli gh repo clone AndreBClark/companiondice
  • use git git clone https://github.com/AndreBClark/companiondice.git

Local Development Setup

  • Fork The Project
  • Clone project
  • Navigate to project directory example:
    • example: cd ./cosmicdivision
  • Node check that nodejs and npm is installed with node -v npm -v
  • Open terminal in project directory and run npm install
  • Run npm start a dev server will open at localhost:1234
  • Edit && Save will live update and refresh the page on the dev server
  • Push to Remote after verifying functionality locally
  • Pull Request create a pull request and describe the changes

Commit Guidelines

  • commit subject lines should be 50 characters or less
  • summarize the changes with a subject/heading followed by a bullet list of changes
  • begin with an emoji write them with a keyword wrapped in colons 📖 book
  • followed by a verb in the imperative ie: add, remove, compile
  • ending with a reference to the relevant issue number with a hashtag and in parentheses ie: (#24) Example:
# emoji 50-character subject line (#25)
#
# Why:
# 

Emojis to be used

  • 🐛 :bug: fix a bug
  • 🔧 :wrench: modify config files
  • 🔥 :fire: remove file or code
  • 📦 :package: bundle, compile build process code/files
  • :sparkles: add feature
  • 😎 :sunglasses: improve styles
  • 🚧 :construction: Work in progress
  • ♻️ :recycle: reformat or refactor code
  • 📖 :book: documentation
  • 🚚 :truck: move files/change folders