Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 1018 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1018 Bytes
Raw

Contributing to GitMe

First off, thank you for considering contributing to GitMe! It's people like you that make GitMe such a great tool.

How Can I Contribute?

Reporting Bugs

  • Check the existing issues to see if the bug has already been reported.
  • If not, open a new issue. Clearly describe the bug and include steps to reproduce it.

Suggesting Enhancements

  • Open an issue with the "enhancement" label.
  • Describe the feature you'd like to see and why it would be useful.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
    • Use npm run lint to ensure code quality.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Style Guide

Follow the established coding style in the project (React + Tailwind CSS).

License

By contributing to GitMe, you agree that your contributions will be licensed under its MIT License.