CONTRIBUTING.md

Contributing to Electron

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

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

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

Issues

Issues are created here.

• How to Contribute in Issues
• Asking for General Help
• Submitting a Bug Report
• Triaging a Bug Report
• Resolving a Bug Report

Issue Maintenance and Closure

• If an issue is inactive for 45 days (no activity of any kind), it will be marked for closure with stale.
• If after this label is applied, no further activity occurs in the next 7 days, the issue will be closed.
  • If an issue has been closed and you still feel it's relevant, feel free to ping a maintainer or add a comment!

Pull Requests

Pull Requests are the way concrete changes are made to the code, documentation, dependencies, and tools contained in the electron/electron repository.

• Setting up your local environment
  • Step 1: Fork
  • Step 2: Build
  • Step 3: Branch
• The Process of Making Changes
  • Step 4: Code
  • Step 5: Commit
    • Commit message guidelines
  • Step 6: Rebase
  • Step 7: Test
  • Step 8: Push
  • Step 8: Opening the Pull Request
  • Step 9: Discuss and Update
    • Approval and Request Changes Workflow
  • Step 10: Landing
  • Continuous Integration Testing

Style Guides

See Coding Style for information about which standards Electron adheres to in different parts of its codebase.

Further Reading

For more in-depth guides on developing Electron, see /docs/development