Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (26 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.19 KB

Contributing to F² AI Projects

Thank you for your interest in contributing! We welcome bug reports, feature requests, documentation improvements, and code contributions.

How to Contribute

Reporting Bugs

  1. Check existing Issues to avoid duplicates
  2. Open a new issue using the Bug Report template
  3. Include steps to reproduce, expected behavior, and actual behavior

Requesting Features

  1. Open an issue using the Feature Request template
  2. Describe the problem you're trying to solve
  3. Explain your proposed solution

Documentation

  • Fix typos, clarify explanations, add examples
  • Open a PR with your changes — no issue required for small fixes

Code Contributions

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Run existing tests to ensure nothing breaks
  5. Submit a pull request

Code Style

  • Follow existing patterns in the codebase
  • Write clear commit messages
  • Keep PRs focused — one feature or fix per PR

Questions?

Open a Discussion or reach out at fsquared.ai/contacts.html.