Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.77 KB

Contributing to Better Howrse

First off, thank you for helping me making the tool better

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Better Howrse. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Better Howrse, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Requests

  • Fork the repo and create your branch from main.
  • If you've added new feature, ensure it works and doesn't break anything
  • Document any changes you've made if you can. Updates to comments, README file, or explanatory notes are always welcome.
  • Push your changes to your forked repository.
  • Open a pull request to the main branch of the original repository.

Code of Conduct

By participating, you are expected to uphold this code. Please report unacceptable behavior to [your email].