Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.14 KB

Contributing to FTL

Thank you for your interest in contributing to FTL! This contribution guide, especially the AI contribution policy, is influenced by Rust, LLVM, and Ghostty.

Ways to Contribute

Reporting Issues

If you find a bug or something is not working as expected, please open an issue. It would be extremely appreciated if you could provide a minimal reproducible example.

Sending Pull Requests

Send PRs on GitHub. Every PR should:

  • be formatted with cargo fmt.
  • include tests (optional for the time being).
  • not contain unrelated changes (please open a separate PR!).
  • be an isolated change - keep a PR small as possible, and focused on a single issue.

Note

If you are interested in FTL and looking for a project to work on, post on GitHub Discussions or contact me.

AI Contribution Policy

We consider AI as a development tool that helps you be more productive, and accept AI-assisted contributions.

That being said, to prevent abuse and ensure the quality of contributions, we have the following guidelines:

  • Keep a human in the loop: You should review and understand the code and text first, before showing it to other humans.
  • Do not copy-and-paste AI-generated texts: This includes PR descriptions, issue comments, discussions. Speak in your own words, understand the AI-generated text, and quote it if it is relevant.
  • You are responsible for what you submit: If you submit low-quality AI-generated code/text, your contributions may be blocked. Don't worry, this is for low-effort spams.
  • AI usage must be disclosed: In PR description or issue comment, disclose AI you used. This is optional, but it is recommended to help other humans.

Note

This policy does not apply to maintainers who already have a high level of trust.