Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

64 lines (39 loc) · 2.33 KB
Raw

Contributing to Readme Stats Updater

First off, thank you for considering contributing to Readme Stats Updater! It's people like you that make it a rewarding experience for both of us, and for the wider community.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to dima.tch.contact@gmail.com.

How Can I Contribute?

Reporting Bugs

Before submitting a bug report, please check the issues to see if the problem has already been reported. If it has not, submit an issue including:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • The expected behavior.
  • Screenshots, if applicable.
  • Any additional context.

Suggesting Enhancements

Enhancement suggestions are welcome! Please submit them as new issues, with a clear and descriptive title and detailed information about the enhancement.

Pull Requests

Pull requests are the best way to propose changes to the codebase. Here's how to do it:

  1. Fork the repository and create your branch from main.
  2. If you've added code, update the documentation accordingly.
  3. Ensure your code lints.
  4. Issue the pull request with a clear description of the changes.

Style Guides

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 Style Guide

Documentation Style Guide

  • Use Markdown for documentation.
  • Keep documentation updates in sync with code changes.

Getting Started

Want to contribute but not sure where to start?

  • Check the issues for tasks that need help.
  • Look for issues labeled good first issue or help wanted.

Questions?

Feel free to contact me or raise an issue if you have any questions about contributing.

Thank you for your interest in contributing to Readme Stats Updater!