OpenLake / OpenLake/OpenLake--Website

Add CONTRIBUTING.md guide for new developers

Open
#43 2 comments 0 reactions 1 assignee View on GitHub

@wcbelolli is already working on this.

Since Apr 6, 2026.

documentation good first issue
Dominant language
TypeScript
Stars
3
Forks
16
Avg merge
8h 54m
Merged PRs (30d)
7

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.