leostera/warp

Open Source Checklist

Open

#15 opened on Mar 21, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (0 forks)github user discovery
documentationenhancementhelp wanted

Repository metrics

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

Description

Hi team, this is a checklist of stuff that we should have in place before announcing the first release. Would love to hear your thoughts and if anything is missing here.

  • CD:
    • CI passes for Linux and macOS
    • New releases are created on tags and published to Github Releases
  • Docs:
    • README.md includes basic information about the project (see https://github.com/denoland/deno/blob/main/README.md)
    • docs.warp.build is deployed from main
    • Installation page shows how to install warp from sources
    • Concepts page explains our core concepts (Target, Signature, Tricorder, Phases, etc)
    • CONTRIBUTING.md includes instructions for
      • How to set up the project locally
      • How to contribute (PR etiquette, commit messages, etc)

Feel free to pick up any of this work, just make an issue for it and go bananas 🚀

cc/ @capitanu @diogomqbm @Enkronan

Contributor guide

Research direction
Review the checklist, pick an uncompleted item, and follow existing patterns in the repository to implement it.
Tech stack
rust
Domain
devopsdocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80