/atmosphere

Primary LanguageTypeScript

Atmosphere

Prerequesites

You will need the following installed on your computer in order to run Atmosphere:

Installing

  1. Clone this repository
    • via HTTPS $ git clone https://github.com/zulaica/atmosphere.git or
    • via SSH $ git clone git@github.com:zulaica/atmosphere.git
  2. $ cd atmosphere
  3. $ yarn

Building

  1. $ yarn build

Serving

  1. $ yarn serve
  2. Visit http://localhost:10001

Contributing

Git Commit Messages[1]

  • Commit early, commit often™
  • Commits should be concise enough to describe in one line
  • Limit commit messages to 80 characters
  • Use the present tense (e.g. "Do the thing" not "Did the thing")
  • Use the imperative mood (e.g. "Do the thing" not "Does the thing")
  • Start the commit message with the appropriate emoji pair (followed by two spaces)
  • Use actual emoji and not Github's emoji short-codes
Emoji Pair Usage Suggested Text Shortcut[2]
Code
🆕 🛠 adding new code ::codenew
🔄 🛠 refactoring code ::codeedit
💨 🐛 fixing a bug ::bugfix
Dependencies
🆕 📦 adding a dependency ::pkgnew
⬆️ 📦 upgrading a dependency ::pkgup
⬇️ 📦 downgrading a dependency ::pkgdown
Documentation
🆕 📝 adding documentation ::docsnew
🔄 📝 editing documentation ::docsedit

License

Atmosphere is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license (CC BY-NC-SA 4.0).

[1] Borrowed heavily from Atom's contribution documentation. ↩️

[2] My handy TextExpander shortcuts, set up to also add the two spaces after the emoji pair. ↩️