summaryrefslogtreecommitdiff
path: root/doc/development/issuable-like-models.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-10-07 06:06:10 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2019-10-07 06:06:10 +0000
commit3900b8a0062113e11e600e4226426e4163ac5e2c (patch)
treecde54fc9de3a74a730fe5c9aab78886e66a95bde /doc/development/issuable-like-models.md
parent0c437c3e2fc1a7def9334fad6d9476e4e7c4af9a (diff)
downloadgitlab-ce-3900b8a0062113e11e600e4226426e4163ac5e2c.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/issuable-like-models.md')
-rw-r--r--doc/development/issuable-like-models.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/development/issuable-like-models.md b/doc/development/issuable-like-models.md
new file mode 100644
index 00000000000..27cac825b7f
--- /dev/null
+++ b/doc/development/issuable-like-models.md
@@ -0,0 +1,19 @@
+# Issuable-like Rails models utilities
+
+GitLab Rails codebase contains several models that hold common functionality and behave similarly to an [Issue]. Other
+examples of `Issuable`s are [Merge Requests] and [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`: 16000 chars
+- `description_html`: 48000 chars
+
+[Issue]: https://docs.gitlab.com/ee/user/project/issues
+[Merge Requests]: https://docs.gitlab.com/ee/user/project/merge_requests
+[Epics]: https://docs.gitlab.com/ee/user/group/epics