Skip to content
This repository has been archived by the owner on May 17, 2024. It is now read-only.

Latest commit

 

History

History
37 lines (24 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.73 KB

Contributing to Twitch-Stats

Thank you for considering contributing to Twitch-Stats! This document outlines the guidelines and instructions for contributing to this project.

Reporting Issues

If you encounter any bugs or issues while using Twitch-Stats, please submit a detailed bug report by following these steps:

  1. Check the existing GitHub Issues to ensure the issue hasn't been reported before.
  2. If the issue doesn't exist, open a new issue.
  3. Provide a descriptive title and include steps to reproduce the issue.
  4. Include any relevant error messages or screenshots that can help with troubleshooting.
  5. Add appropriate labels to the issue (e.g., bug, enhancement) and assign it to the relevant project milestone if applicable.

Pull Requests

Contributions in the form of pull requests are welcome. To submit a pull request:

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Make your changes and ensure that the code passes any existing tests.
  3. Provide clear and descriptive commit messages.
  4. Push your branch to your forked repository.
  5. Submit a pull request to the main branch of the original repository.
  6. Ensure that the pull request description explains the changes made and provides any necessary context.

Code Style and Guidelines

  • Follow the existing code style and conventions used in the project.
  • Write clear and concise code with appropriate comments where necessary.
  • Make sure your code is properly formatted.
  • Write meaningful and descriptive variable and function names.

We appreciate your contribution to improving Twitch-Stats! Thank you for your support!