Create CONTRIBUTING.md File

[aayank13]

Title

Create CONTRIBUTING.md File

Enhancement Aim

Develop a CONTRIBUTING.md file to guide new contributors on how to get involved with the ML4E project. This file should provide essential information on setting up the development environment, contributing code, and submitting issues or pull requests.

Goals:

• Outline clear guidelines for contributing to the project.
• Ensure contributors understand the steps for forking, cloning, creating branches, and making pull requests.
• Include code standards and best practices for consistency.

Changes

Tasks:

1. Introduction: Provide a welcome message for new contributors and explain the purpose of this file.
2. Getting Started:
   • Steps for forking the repository.
   • Cloning the fork and setting up a local environment.
   • Installing dependencies.
3. Contribution Workflow:
   • Instructions for creating a new branch and naming conventions.
   • Code standards and best practices.
   • Writing meaningful commit messages.
4. Submitting a Pull Request (PR): Describe how to submit a PR, link issues, and address feedback.
5. Reporting Issues: Guidelines on how to report bugs or suggest new features.
6. Community Code of Conduct: Brief mention of any code of conduct guidelines or a link if there’s a separate file.

Acceptance Criteria:

• The CONTRIBUTING.md file should be comprehensive yet concise.
• All key sections (Introduction, Getting Started, Workflow, PR Guidelines, Reporting Issues) are included.
• Language is clear and approachable for contributors of all experience levels.

Screenshots 📷

No response

Guidelines

• [X] I have read the guidelines
• [X] I have the link to my latest merged PR

Full Name

Aayan

Participant Role

Admin

[github-actions[bot]]

🙌 Thank you for bringing this issue to our attention! We appreciate your input and will investigate it as soon as possible.

[github-actions[bot]]

✅ This issue has been closed. Thank you for your contribution!