kubernetes-sigs/cluster-api-provider-aws

Create ARCHITECTURE.md

Open

#2,256 opened on Feb 18, 2021

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Go (689 forks)auto 404
help wantedkind/documentationkind/featureneeds-triagepriority/important-soon

Repository metrics

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

Description

/kind feature /kind documentation /help

Describe the solution you'd like Create a ARCHITECTURE.md file in the root to help new contributors understand the codebase and the architecture of the provider.

This should also be linked into the doc under the "development" section

Environment:

  • Cluster-api-provider-aws version: 0.6.4

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.