Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 2.57 KB

contributing.md

File metadata and controls

34 lines (27 loc) · 2.57 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Ensure your pull request adheres to the following guidelines:

  • The pull request should have a useful title and include a link to the thing you're submitting and why it should be included.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
  • If you just created something, wait at least 30 days before submitting.
  • The project repo should have at least 40 stars.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Boilerplates are not accepted as most boilerplates are too opinionated and low-quality and I don't have time to comment on everything they need to improve.
  • If you're submitting a closed source app, include evidence of it being built with Electron.
  • The "Closed Source" section has a very high bar for acceptance. You're a lot more likely to get accepted if you link to a blog post on how you built the app. Don't worry if your submission is declined, you can still submit your app to the official Electron apps list.
  • Submitted open source apps should have a English readme, screenshot of the app in the readme, and a binary for at least one OS, preferably macOS, Linux and Windows.
  • Submitted packages should be tested and documented.
  • Make an individual pull request for each suggestion.
  • Use the following format: [title](link) - Description.
  • Additions should be added to the bottom of the relevant section.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Don't mention Electron in the description as it's implied.
  • Don't start the description with A or An.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.

Thank you for your suggestion!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.