summaryrefslogtreecommitdiff
path: root/doc/development/contributing
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-06-18 09:08:41 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-06-18 09:08:41 +0000
commite1d53af7ad463decf1df2944343c66b27512d4e1 (patch)
tree10daa46d5c85d5f93f7431c106367a1deb166fd7 /doc/development/contributing
parentef19a5c55c0f38b29f7ac98119041b054c6579c7 (diff)
downloadgitlab-ce-e1d53af7ad463decf1df2944343c66b27512d4e1.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/contributing')
-rw-r--r--doc/development/contributing/style_guides.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md
index 9e4870eadc4..1f920c40dcf 100644
--- a/doc/development/contributing/style_guides.md
+++ b/doc/development/contributing/style_guides.md
@@ -56,6 +56,16 @@ Additionally, we have a dedicated
[newlines style guide](../newlines_styleguide.md), as well as dedicated
[test-specific style guides and best practices](../testing_guide/index.md).
+### Creating new RuboCop cops
+
+Typically it is better for the linting rules to be enforced programmatically as it
+reduces the aforementioned [bike-shedding](https://en.wiktionary.org/wiki/bikeshedding).
+
+To that end, we encourage creation of new RuboCop rules in the codebase.
+
+When creating a new cop that could be applied to multiple applications, we encourage you
+to add it to our [GitLab Styles](https://gitlab.com/gitlab-org/gitlab-styles) gem.
+
## Database migrations
See the dedicated [Database Migrations Style Guide](../migration_style_guide.md).