search

Amna-Hassan04 / Serenity-Guide

SereniFi Guide is a personalized relaxation app offering meditations, breathing exercises, and calming music to help users achieve mental tranquility.
https://serenify.streamlit.app/
Other
30 stars 85 forks source link

Documentation - Add CONTRIBUTING.md file #150

Open Nikhil0-3 opened 1 week ago

Nikhil0-3 commented 1 week ago

Feature Title

contributing.md

Problem Statement

Without a CONTRIBUTING.md file, potential contributors may not know how to contribute effectively. This could lead to inconsistencies in contributions and confusion among contributors.

.

Proposed Solution

Adding the following topics - Project Overview Getting Started Welcome, Contributors Contribution Guidelines Technologies Used How to Submit a Pull Request Issue Report Process Community and Communication Project Structure Looking for Ideas? Join the Mission! If any further changes required please let me know.

Alternatives Considered

No response

Additional Context

No response

github-actions[bot] commented 1 week ago

👋 Thank you! Welcome to the project! Please follow these guidelines for smooth collaboration:

  1. After completing a task, add your name and details to the Contributors Table/List.
  2. Attach relevant screenshots or videos of your contribution for transparency.
  3. Tasks are assigned on a first-come, first-served basis.
    • Avoid spamming requests for already-assigned tasks.
    • Respect the queue and wait for new tasks.
  4. Propose New Ideas: Discuss new features or suggestions in the "Ideas" channel before starting work.
Nikhil0-3 commented 1 week ago

Please assign this issue to me.I would like to work on that.

Amna-Hassan04 commented 5 days ago

@Nikhil0-3 you can work on this but first u will have to calculate if teh total contributions related to documentation havent reached 150 points which i suppose they have.

Ricky2054 commented 3 days ago

Kindly assign me this issue