Skip to content

Add CONTRIBUTING.md to Guide New Contributorsย #3

@SIDDHI-1105

Description

@SIDDHI-1105

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.

Metadata

Metadata

Assignees

Labels

good first issueGood for newcomersgssoc'25this issue is a part of girl script summer of code 2025level1

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions