summaryrefslogtreecommitdiff
path: root/doc/development/issuable-like-models.md
blob: 3892f56156e9b1e29bb509d904cab9d065e7791c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Issuable-like Rails models utilities

GitLab Rails codebase contains several models that hold common functionality and behave similarly to
[Issues](https://docs.gitlab.com/ee/user/project/issues/). Other examples of "issuables"
are [Merge Requests](https://docs.gitlab.com/ee/user/project/merge_requests/) and
[Epics](https://docs.gitlab.com/ee/user/group/epics/).

This guide accumulates guidelines on working with such Rails models.

## Important text fields

There are max length constraints for the most important text fields for `Issuable`s:

- `title`: 255 chars
- `title_html`: 800 chars
- `description`: 1 megabyte
- `description_html`: 5 megabytes