Skip to content

Conversation

@Rashidaga18
Copy link

Issue #17 Resolved

This PR adds a CONTRIBUTING.md file to the repository.
It provides structured guidelines for contributors on how to set up the project, follow coding practices, and collaborate effectively.

Key Contents

  • Project Overview – Brief introduction to the project and its goals.

  • Setup Guide – Steps to clone, install dependencies, and run the project locally.

  • Contribution Guidelines – Instructions for fixing bugs, adding new features, and writing modular, maintainable code.

  • Branching & PR Workflow – Clear rules for creating feature/bugfix branches, submitting PRs, and review protocols.

  • Commit Message Standards – Uses conventional commit style for clarity and versioning.

  • Testing Instructions – Contributors must write and run tests before PR submission.

  • Issue Reporting Guide – How to report bugs with proper reproduction steps, expected vs actual results, and supporting logs/screenshots.

  • Code of Conduct – Standards for respectful collaboration and inclusivity.

Why This Is Important

  • Helps first-time contributors onboard quickly.

  • Ensures consistency in code and collaboration.

  • Reduces repetitive queries for maintainers.

  • Encourages open-source community involvement.

@vercel
Copy link

vercel bot commented Aug 24, 2025

@Rashidaga18 is attempting to deploy a commit to the relatablepradeep's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant