Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-11-01 19:07:38 +01:00
Code Issues Projects Releases Wiki Activity
46c9f8bd54
unleash.unleash/website/docs/contributing/ADRs/overarching/domain-language.md
Fredrik Strand Oseberg ad7c139992
fix: add ADR for domain language (#2541) 
This PR puts our contributing guidelines in the sidebar of the unleash
documentation. Currently there was no way of navigating to them easily,
which made our contribution guides and ADRs less useful. This PR adds
them to the sidebar as their own category, and adds an ADR for domain
centric language.

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-29 08:57:27 +01:00

1.3 KiB
Raw Blame History

title
ADR: Domain language

Background

In the codebase, we have seen the need to define a domain language that we use to refer to features, methods to keep it consistent across the codebase. This ADR will contain a growing list of domain language used to keep the consistency across the codebase.

Decision

We have decided to use the same domain language for the features we develop. Each feature will have it's own domain language to keep it consistent across the codebase.

Change requests domain language

  • Change request: An entity referring to the overarching data structure of a change request. A change request contains changes, and can be approved or rejected.
  • Change: A term referring to a single change within a change request
  • Changes: A term referring to a group of changes within a change request
  • Discard: A term used for deleting a single change of a change request, or discarding an entire change request.
  • Pending: A pending change request is one that has not yet been applied or discarded. In other words, it is in one of these three states:
    1. Draft
    2. In review
    3. Approved
  • Closed: A closed change request has either been applied or cancelled and can no longer be changed. Change requests that are either Applied or Cancelled are considered closed.