kedacore/keda

Contributor guide for naming and conventions

Open

#592 opened on Jan 30, 2020

View on GitHubContributor guide
 (7 comments) (0 reactions) (0 assignees)Go (1,457 forks)auto 404
docs:improvement-requiredenhancementhelp wantedstale-bot-ignore

Repository metrics

Stars
 (10,372 stars)
PR merge metrics
 (PR metrics pending)

Description

Want to derive consistency around scalers, but also help new contributors follow the right patterns so we don't have to break / change in the future. We should document the naming conventions and patterns followed.

Contributor guide

Research direction
Review existing scaler implementations and their names, then create a document outlining consistent naming conventions and patterns.
Tech stack
go
Domain
backend
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
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75