Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

30 lines (26 loc) · 2.12 KB
Raw

Contribution Guidelines

The pull request should have a useful title. Pull requests with Update readme.md as title will be closed right away. Please make sure you checked every box in the PR template.

Adding an item to the list

  1. Make sure you are editing README.md only, no other files are allowed to be edited.
  2. Add your item to the category it belongs to. Try to avoid creating completely new categories.
  3. Make sure your item is added to the bottom of the items listed in a category, don't add it in at the middle.
  4. Don't submit dead links and try to always submit HTTPS links.
  5. Make sure you're linking to an English resource, other languages not allowed at this moment
  6. If there is only support for some devices please mention that by using the badges provided.
  7. Add something that is truly awesome and stands out. A project that shows how to monitor a greenhouse, water a plant or trigger LEDs are already out there on the web. This is not the place for those.

Adding to the list

  1. Click README.md
  2. Click the pencil button in the upper right corner next to raw | blame | history
  3. Github will automatically create a fork for this repo on your account.
  4. Put your edit in.
  5. At the bottom of the page fill in a meaningful commit summary and click Propose file change.
  6. You'll be taken to the PR screen, click the Create Pull Request button
  7. Make sure you check the boxes (and actually make sure they're right) and click Create Pull Request

Gitmoji

It's recommended that you use gitmoji when contributing. The supported gitmoji must proceed the commit message followed by a space and be one of:

Name, Use Emoji Example
:heavy_plus_sign:, Adding items ➕ git commit -m ":heavy_plus_sign: Added motionEye OS to the OS list"
:heavy_minus_sign:, Removing items ➖ git commit -m ":heavy_minus_sign: Removed motionEye OS from the OS list"
:truck:, Moving Items 🚚 git commit -m ":truck: Moved motionEye OS from Projects to OS's"
:pencil2:, Fixing typos ✏️ git commit -m ":pencil2: Fixed typo for Raspbian Jessie Lite"