Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (50 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 2.69 KB

Contributing to Hunger Hive

Thank you for considering contributing to Hunger Hive! This document outlines the process for contributing to the project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior.

How Can I Contribute?

Reporting Bugs

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

Before Submitting A Bug Report:

  • Check the issues for a list of known issues.
  • Perform a cursory search to see if the problem has already been reported.

How Do I Submit A Good Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the behavior
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if applicable
  • Include details about your configuration and environment

Suggesting Features

This section guides you through submitting a feature suggestion, including completely new features and minor improvements to existing functionality.

Before Submitting A Feature Suggestion:

  • Check if the feature has already been suggested.
  • Think about whether your feature aligns with the project's goals.

How Do I Submit A Good Feature Suggestion?

Feature suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested feature
  • Provide specific examples to demonstrate the steps
  • Explain why this enhancement would be useful
  • Include mockups or examples if applicable

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs if applicable
  • End all files with a newline
  • Avoid platform-dependent code
  • Follow the code style used in the project

Styleguides

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 after the first line

JavaScript Styleguide

All JavaScript must adhere to the standard JavaScript style guide.

CSS Styleguide

All CSS must adhere to the Tailwind CSS conventions.

License

By contributing to Hunger Hive, you agree that your contributions will be licensed under the project's MIT License.