Skip to content

Add CONTRIBUTING.md to guide new contributors and GSoC applicants #152

@Jai-76

Description

@Jai-76

Summary

The repository currently lacks a CONTRIBUTING.md file. For a GSoC-focused repo
that is specifically meant to onboard new open-source contributors, this is a
significant gap.

Why it matters

  • GSoC applicants often look for contribution guidelines as their first step
  • Without clear instructions, contributors may submit inconsistent PRs or feel lost
  • Many GSoC orgs are evaluated on how welcoming their repo is to newcomers

Suggested contents for CONTRIBUTING.md

  • How to fork and clone the repo
  • Folder structure explanation (2022/, 2023/, 2024/, 2025/, project folders)
  • How to propose a new GSoC project idea
  • Coding/notebook style guidelines (since 91% of the repo is Jupyter Notebooks)
  • How to open a good issue or pull request
  • Links to onboarding resources (OREL intro, DevoWorm guide, etc.)
  • Code of Conduct reference

References

Would be happy to draft this file if maintainers can confirm the preferred structure!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions