Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.48 KB

Contributing to Literaku

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Literaku. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Literaku. 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 steps to reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

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. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

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

TypeScript / React Styleguide

  • Use Functional Components with Hooks.
  • Use interface for props definitions.
  • Keep components small and focused.
  • Use Tailwind CSS utility classes for styling.

Thank you for your contributions!