diffplug / diffplug/gitcasso

Glossary

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
58
Forks
0
PR merge metrics
No merged PRs in 30d

Description

- ~~**Comment**~~ - avoid this word because it is ill-defined
- **CommentSpot** - the logical *location* of a comment. Such as `new comment on github.com issue diffplug/selfie#37`
- **CommentDraft** - the specific contents of a **CommentSpot** at a specific instant in time
- **CommentEnhancer** - an interface which takes a raw `textarea`, determines if it represents a known **CommentSpot**

If you think any of these terms are unclear, feel free to discuss below. If there are any other concepts in the code which should be defined explicitly, feel free to discuss below. The final result of all discussions is incorporated into the list above via editing, after which the discussions may be deleted. This glossary is based on an idea from Rich Hickey's [Design in Practice](https://thecontextwindow.ai/i/139974825/glossary) talk.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.