-
-
Notifications
You must be signed in to change notification settings - Fork 14
Description
Hi maintainers ๐
Iโve been exploring the otpauthentication project โ itโs a really useful FastAPI + Twilio-based OTP login system! ๐
To make the repository more contributor-friendly and maintainable, Iโd like to suggest adding a CONTRIBUTING.md file that outlines clear steps for contributing to the project.
โจ Suggested Contents for CONTRIBUTING.md:
๐ฅ How to clone and set up the project locally
๐ How to configure Twilio credentials securely (e.g., via .env)
๐ Running the FastAPI server
๐งช Writing tests (if applicable)
๐ How to create and submit a pull request (PR)
๐ Any code style, formatting, or branch naming conventions
โ Good first issues or beginner-friendly contribution areas
โ
Why This Matters:
Lowers the barrier for new contributors
Encourages clean, consistent contributions
Saves maintainer time by answering common setup questions
Boosts project visibility and community involvement
Iโd be happy to draft and contribute the initial CONTRIBUTING.md file myself if you'd like! Just let me know if you have any specific preferences you'd want included.