search

MohammedHamzaMalik / data-science-pipeline-playground

Apache License 2.0
1 stars 3 forks source link

Help Wanted: Create CONTRIBUTING.md file for our repository #1

Closed MohammedHamzaMalik closed 1 month ago

MohammedHamzaMalik commented 1 month ago

Create CONTRIBUTING.md File

We need help creating a comprehensive CONTRIBUTING.md file for our Data Science Pipeline Playground repository. This file will guide new contributors on how to participate in our project effectively.

Objective

Create a well-structured CONTRIBUTING.md file that covers:

  1. Introduction and welcome message
  2. Code of Conduct reference
  3. How to contribute:
    • Reporting bugs
    • Suggesting enhancements
    • Submitting pull requests
  4. Style guides for:
    • Git commit messages
    • Python code (PEP 8)
    • Documentation
  5. Labels used in the project
  6. Any other relevant information for contributors

Requirements

Additional Notes

How to Contribute

If you're interested in taking on this task:

  1. Comment on this issue to express your interest
  2. Fork the repository
  3. Create a new branch for this task
  4. Create the CONTRIBUTING.md file
  5. Submit a pull request with your proposed CONTRIBUTING.md

We appreciate any help in making our project more accessible and contributor-friendly!

Labels: documentation, help wanted, good first issue

NidhiNayak08 commented 1 month ago

i will do this

EzazAA commented 1 month ago

I can i do that, If you prefer more engaging and beautiful text,, you might reach me out

MohammedHamzaMalik commented 1 month ago

i will do this

Ok I will assign you

MohammedHamzaMalik commented 1 month ago

I can i do that, If you prefer more engaging and beautiful text,, you might reach me out

I have assigned this issue to @NidhiNayak08 as she came first, she has two days to complete the task if she doesn't then I will assign it to you, or if you want you can work on other issues