Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.34 KB
Raw

Contributing

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

The following is a set of guidelines for contributing to this project. 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 on debugging and submitting issues, and include as many details as possible with your report.
  • Include the version of DropCap you are using and the OS.
  • Include screenshots and animated GIFs whenever possible; they are immensely helpful.
  • Include the behavior you expected.
  • On Mac, check Console.app for stack traces to include if reporting a crash.
  • Perform a search to see if a similar issue has already been submitted.

Pull Requests

  • If modifying the UI of the app, please include screenshots and/or animated GIFs to showcase your changes.
  • Although no strict code styleguide is enforced, please try to match the current style

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