Skip to content

docs: Establish comprehensive Organization-wide CONTRIBUTING.md guidelines #3

Description

@abhinavkdeval08-design

Overview

To prepare the Vibrodo-Music ecosystem for future open-source collaborations and to ensure strict adherence to engineering standards (vital for GSoC/LFX evaluation standards), we need a centralized CONTRIBUTING.md file within our global .github repository.

Requirements

Create a CONTRIBUTING.md file in the root of the .github repository covering the following sections cleanly:

  1. Welcome Message: A brief intro welcoming contributors to the future of mood-based music ecosystems.
  2. Code of Conduct Reference: Pointing them to follow our community guidelines.
  3. How to Contribute:
    • Finding issues tagged with good first issue or help wanted.
    • Proposing changes or new algorithms via issues first before starting code.
  4. Git Workflow & Standards:
    • Mandatory branch naming convention (e.g., feature/, bugfix/, docs/).
    • Clean, descriptive commit messages.
    • Requirements for signed commits if necessary (DCO standard alignment).
  5. Pull Request Checklist: Explicit steps to check local builds, run checks, and request a review from maintainers before merging.

Reference Styles

Please ensure clean Markdown formatting using bold labels, clear lists, and dividers (---) to keep it readable and matching our organization profile design.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

Type

Fields

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions