OpenLake/OpenLake--Website

Add CONTRIBUTING.md guide for new developers

Open

#43 opened on Apr 5, 2026

View on GitHub
 (2 comments) (0 reactions) (1 assignee)JavaScript (12 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

🔍 Summary

No CONTRIBUTING.md file found. This is the first file new contributors look for when joining a project.

📋 What Needs to Be Done

  • Create CONTRIBUTING.md at repository root with:
    • Development environment setup instructions
    • Code style guidelines and linting configuration
    • Git workflow (branch naming, commit message conventions)
    • Pull request template and checklist
    • How to run tests locally
    • How to report bugs
    • Code of Conduct reference

💡 Template

GitHub provides a starter template: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Contributor guide

Research direction
Create a CONTRIBUTING.md file following the checklist in the issue description. Use GitHub's template as a starting point. Ensure it covers all sections listed. Submit a pull request.
Tech stack
javascript
Domain
documentationdeveloper experiencetooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95