Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.22 KB
Raw

Contributing to electron.atom.io

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to electron.atom.io on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Issues & Pull Requests

  • If you're not sure about adding something, open an issue to discuss it.
  • Feel free to open a Pull Request early so that a discussion can be had as changes are developed.
  • Include screenshots and animated gifs of your changes whenever possible.
  • End files with a newline.

Adding an app or project to the site

If you have an Electron application or project you'd like to see added, please open a pull request.

Add your app to the list by editing _data/apps.yml.

Please add your app at the bottom of the list.

  • The required fields are name, website, and icon. Everything else is optional, but recommended.
  • Your website can be a repository with a README, but please provide a destination with information about your app.
  • Your icon must be 256x256 pixels in size.
  • Your icon must be a PNG.
  • Put your icon in the images/apps folder.
-
  name: "Your App"
  description: "A few words about your app"
  website: "https://yourapp.com"
  repository: "https://github.com/your/app"
  keywords:
    - "friends"
    - "music"
  license: "MIT"
  icon: "lowercase-and-url-friendly.png"

Adding a meetup to the site

If you want to add a meetup to the community site please open a pull request.

Add the meetup to the list by editing _data/meetups.yml.

-
  name: Name of Group
  location: City, State (if applicable)
  country: Country
  href: Link to meetup's site

Please add the meetup at the bottom of the list.

Documentation

The documentation on this site is pulled directly from the electron/electron repository's docs directory. Contributions to the documentation should be made there: electron/electron.