Contributing

Practical ways to contribute through GitHub while respecting project scope.

Start with a conversation

All products remain In development. Use the community GitHub channels to find existing issues, propose an idea, request a provider, or discuss a documentation improvement. Agree on a focused change with maintainers before starting substantial work.

The source-code license remains undecided. Read the license page before assuming permissions to reuse or distribute code.

Prepare a useful proposal

Explain who benefits, the current problem, and the desired outcome. For providers, include public documentation, access requirements, usage restrictions, and sample public records. Do not send credentials, private provider payloads, or copyrighted book files.

For bugs, include the affected product, version if available, environment, reproduction steps, and expected and actual behavior. Follow the support guidance and report suspected vulnerabilities privately.

Propose and review changes

When a source repository and contribution workflow are available to you, use its documented setup and checks. Keep pull requests focused, explain the behavior change, include relevant tests, and update public documentation where needed. Maintainers review correctness, accessibility, privacy, compatibility, and the Free Always pledge.

Follow the code of conduct during review. Donations do not confer priority, influence, recognition, or preferential treatment.