CONTRIBUTING.md

Thank you for contributing to alerts-js.

Here you can read some general information about how to contribute to the project.

Styleguides

Code

We're using the google styleguide for ES-Lint. Please keep writing in this style all the time. Ask before changing anything in the ES-Lint file. Try use self explainable variable names, if you have to create a comment for the variable I recommend you to change the variable name instead. Try to use ES6 syntax or newer. Development 💻 is separated in 3 steps: 1. Make it work, 2.Make it clean, 3.Make it fast

Design

If you want to contribute by creating a design for AlertJS, you've to view the basic structure of our alerts first. Like in the image above the alert consists of a background which contains the main information of the alert. On the top of the alert is an optional icon to create a clear expression of the card. Beneath is a big title with the core message of the alert and followed by a description or note. On the bottom there's usually one or two buttons which contain the actions you want the user to take. Feel free to play around with colors, fonts etc. and create awesome designs. Please send us your design as an image file or as .psd .xd and so on. We're looking forward to see awesome designs from you 😄!

Commits

• Consider starting the commit message with an applicable emoji:
  • 🎨 :art: when improving the format/structure of the code
  • 🐎 :racehorse: when improving performance
  • 🚱 :non-potable_water: when plugging memory leaks
  • 📝 :memo: when writing docs
  • 🐧 :penguin: when fixing something on Linux
  • 🍎 :apple: when fixing something on macOS
  • 🏁 :checkered_flag: when fixing something on Windows
  • 🐛 :bug: when fixing a bug
  • 🔥 :fire: when removing code or files
  • 💚 :green_heart: when fixing the CI build
  • ✅ :white_check_mark: when adding tests
  • 🔒 :lock: when dealing with security
  • ⬆️ :arrow_up: when upgrading dependencies
  • ⬇️ :arrow_down: when downgrading dependencies
  • 👕 :shirt: when removing linter warnings
  • 🆕 :new: when adding new functionality
  • 🌟 :star2: when styling the content