Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 2.29 KB

Contributing to Webplex

First off, thanks for taking the time to submit your contribution.

The following is a set of guidelines for contributing to Webplex, which is hosted in the MEDIANECT organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of contents

I have a question

Code of conduct

I have a question

You should not open issues for asking questions. There is many websites around, that you probably know about, which are dedicated to discussions on particular topics or even are purposed as Q&A searchable repositories.

Of course, popularity matters and for the time being you may obtain a response from an opened issue, but we would be glad if you first tried towards these beforementioned specialized channels.

Code of conduct

This project and every of its contributions is governed by the Code of Conduct. By participating, you are expected to uphold this code (so better read it).

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line,
  • 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