Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.28 KB

Contributing to PenFerry

First off, thank you for considering contributing to PenFerry!

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description of the feature you'd like to see.
  • Include as many details as possible and describe the steps that the feature should work.

Pull Requests

  • Fork the repository and create your branch from master.
  • Ensure the test suite passes.
  • Issue that pull request!

Styleguides

Git Commit Messages

We use conventional commit messages. Please follow the conventional commits specification. To make this process easier and more consistent, consider using the tool turboCommit, which can help automate the generation of conventional commits.