contributing.md

Contributing to elektron

First and foremost, thank you! We appreciate that you want to contribute to elektron, your time is valuable, and your contributions mean a lot to us.

What does "contributing" mean?

Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following:

• Updating or correcting documentation
• Feature requests
• Bug reports

If you'd like to learn more about contributing in general, the Guide to Idiomatic Contributing has a lot of useful information.

Showing support for elektron

Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.

Don't have time to contribute? No worries, here are some other ways to show your support for elektron:

• star the project
• tweet your support for elektron

Issues

Before creating an issue

Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues.

Try to follow these guidelines

• Investigate the issue:
• Check the readme - oftentimes you will find notes about creating issues, and where to go depending on the type of issue.
• Create the issue in the appropriate repository.

Creating an issue

Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue:

• version: please note the version of elektron are you using
• extensions, plugins, helpers, etc (if applicable): please list any extensions you're using
• error messages: please paste any error messages into the issue, or a gist

Above and beyond

Here are some tips for creating idiomatic issues. Taking just a little bit extra time will make your issue easier to read, easier to resolve, more likely to be found by others who have the same or similar issue in the future.

• read the Guide to Idiomatic Contributing
• take some time to learn basic markdown. This markdown cheatsheet is super helpful, as is the GitHub guide to basic markdown.
• Learn about GitHub Flavored Markdown. And if you want to really go above and beyond, read mastering markdown.
• use backticks to wrap code. This ensures that code will retain its format, making it much more readable to others
• use syntax highlighting by adding the correct language name after the first "code fence"