aayank13 / ml4e

ML4E - Machine Learning for Everyone
https://ml4e.vercel.app
Apache License 2.0
1 stars 2 forks source link

Create CONTRIBUTING.md File #6

Closed aayank13 closed 2 hours ago

aayank13 commented 2 hours ago

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:

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:

Screenshots 📷

No response

Guidelines

Full Name

Aayan

Participant Role

Admin

github-actions[bot] commented 2 hours ago

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

github-actions[bot] commented 2 hours ago

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