Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (42 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 3.01 KB
Raw

Contributing to Awesome TextConvo

Thank you for adding to the list. The bar here is usefulness, not polish.

What belongs here

  • Tutorials, blog posts, and cookbooks that teach someone to build something with TextConvo.
  • Videos, talks, and recorded walkthroughs.
  • Open-source libraries, wrappers, framework adapters, receivers, and CLI tools — official or not.
  • Integrations and connectors for tools TextConvo does not natively support.
  • Independent comparisons, migration write-ups, and post-mortems. Honest ones especially.
  • Customer-facing examples where a real implementation is visible or described.

What does not

  • Marketing pages, product landing pages, and press releases.
  • Affiliate, referral, or tracking links. They will be stripped or the pull request closed.
  • Paywalled content presented as if it were free. Label it clearly if you add it.
  • Abandoned projects: no commits in two years, or a README that no longer matches the code.
  • Anything that duplicates textconvo.ai/docs. Link the docs instead.
  • Content containing real API keys, phone numbers, or customer data — in the linked resource as well as the pull request.

How to add a link

  1. Fork the repository and create a branch, for example add/fastapi-receiver-guide.
  2. Add your entry to the right section of README.md, keeping alphabetical order within the section.
  3. Use this format:
- [Title](https://example.com) — One sentence saying what the reader gets. No adjectives.
  1. One link per pull request. It keeps review fast and history readable.
  2. Title your pull request add: <title>.

Style rules

  • Use an em dash between the link and the description, and end the description with a period.
  • Write in the third person and the present tense.
  • Describe the outcome, not the vibe: "Shows how to verify webhooks in FastAPI" beats "An amazing deep dive".
  • Keep descriptions under about 100 characters.
  • Do not add badges, emoji, or bold to entries.
  • Label unofficial projects as unofficial in the description.

Adding your own work

Encouraged, with one condition: disclose the relationship in the pull request description. "I wrote this" or "I maintain this project" is all that is needed. Please also consider adding something you did not write while you are here.

Review

A maintainer checks that the link works, the description is accurate, the resource is genuinely useful, and there are no credentials or personal data in it. Expect a response within a few business days. If we decline, we will say why.

Removals

Open an issue if a link is dead, a project is abandoned, or content has become misleading. Removals are as valuable as additions — a stale list is worse than a short one.

Code of conduct

Participation is governed by the TextConvo Code of Conduct.

License

By contributing you agree that your additions to this list are released under CC0 1.0. The resources you link keep their own licenses.