Add a CONTRIBUTING.md to guide contributions #1
Description
Description:
Currently, the repository does not have a dedicated CONTRIBUTING.md file. While there is a brief "Contributing" section in the README, it does not provide detailed guidance on how contributors should submit changes, adhere to code standards, run tests, or structure pull requests. A proper CONTRIBUTING.md would make it easier for new contributors to participate effectively and maintain project quality.
Suggestion:
Create a CONTRIBUTING.md file that includes:
Getting Started: How to set up the development environment.
Branching and Git Workflow: Recommended branch naming and workflow (feature/fix/release).
Code Style: Guidelines for code formatting, linting, and commit messages.
Testing: Instructions for running tests and adding new tests.
Pull Request Process: Steps for submitting PRs, including review expectations.
Communication & Issues: How to report bugs, request features, or ask questions.
Optional: Links to style guides, coding standards, or GitHub templates.
Benefits:
Provides a clear, structured guide for contributors.
Reduces confusion and onboarding time for new contributors.
Ensures consistency in code quality and workflow.
Encourages more community contributions and engagement.