contributing.md
1.87 KB
Contributing to electron-rebuild
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 electron@github.com.
The following is a set of guidelines for contributing to electron-rebuild. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
Submitting Issues
- You can create an issue here,
but before doing that please read the notes below and include as many details as
possible with your report. If you can, please include:
- The version of electron and electron-rebuild you are using
- The operating system you are using
- If applicable, what you were doing when the issue arose and what you expected to happen
- Other things that will help resolve your issue:
- Screenshots and animated GIFs
- Error output that appears in your terminal, dev tools or as an alert
- Perform a cursory search to see if a similar issue has already been submitted
Submitting Pull Requests
- Include screenshots and animated GIFs in your pull request whenever possible.
- Write documentation in Markdown.
- Use short, present tense commit messages. See Commit Message Styleguide.
Git Commit Messages
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- When only changing documentation, include
[ci skip]
in the commit description