Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
127 lines (89 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

127 lines (89 loc) · 2.85 KB

Contributing to Flare

First off, thank you for considering contributing! 🎉
We welcome contributions from everyone, whether it’s reporting bugs, suggesting new features, improving the docs, or jumping in with code changes.

Table of Contents

Code of Conduct

By participating in this project, you agree to follow our Code of Conduct.
Be respectful, constructive, and welcoming to all contributors.

How to Contribute

You can contribute in many ways:

  • Bug reports: Open an issue with steps to reproduce.
  • Feature requests: Suggest new features or enhancements.
  • Documentation: Improve README, examples, or type definitions.
  • Code contributions: Add features, fix bugs, or refactor code.

Development Setup

  1. Fork the repo

  2. Clone your fork locally:

    git clone https://github.com/your-username/flare.git
cd flare

  3. Install dependencies:

    npm install

  4. Build the project:

    npm run build

  5. Run tests:

    npm test

  6. Make changes in a feature branch (see Branching & Commits below).

Branching & Commits

  • Create a feature branch from dev:

    git switch -c your-feature

  • Use kebab-case for branch names.

Perfect! That’s a good workflow to automatically link PRs to issues. You can add this guideline to your CONTRIBUTING.md. Here’s a suggested section to include under Pull Requests:

Pull Requests

  1. Push your branch to your fork.

  2. Open a Pull Request against dev.

  3. Link PR to an issue (if applicable):

    • Include the issue number in the PR title:

      Correct event handling (#12)

    • In the PR description, add:

      Closes #12

      This will automatically close the issue when the PR is merged.

  4. PR checklist:

    • Code passes existing tests.
    • Added tests for new features/bug fixes.
    • Update README/docs if needed.
    • Follows code style and linting rules.

Style Guide

  • Use TypeScript for new code.
  • Prefer async/await over raw promises when possible.
  • Keep functions small and focused.

Reporting Bugs

  • Include a clear description of the problem.
  • Steps to reproduce, expected vs. actual behavior.
  • Environment: Node version, OS, package version.

Feature Requests

  • Explain why this feature is useful.
  • Include examples of how it would work.

Thank you for helping make Flare better! 💖