Add CONTRIBUTING.md File #17 #25
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.