diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 12:55:51 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 12:55:51 +0300 |
commit | e8d2c2579383897a1dd7f9debd359abe8ae8373d (patch) | |
tree | c42be41678c2586d49a75cabce89322082698334 /doc/development/contributing | |
parent | fc845b37ec3a90aaa719975f607740c22ba6a113 (diff) |
Add latest changes from gitlab-org/gitlab@14-1-stable-eev14.1.0-rc42
Diffstat (limited to 'doc/development/contributing')
-rw-r--r-- | doc/development/contributing/issue_workflow.md | 4 | ||||
-rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 6 | ||||
-rw-r--r-- | doc/development/contributing/style_guides.md | 28 |
3 files changed, 33 insertions, 5 deletions
diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index 840434ebbc3..aa1b353c634 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -36,7 +36,7 @@ the affected files to find someone. We also use [GitLab Triage](https://gitlab.com/gitlab-org/gitlab-triage) to automate some triaging policies. This is currently set up as a scheduled pipeline (`https://gitlab.com/gitlab-org/quality/triage-ops/pipeline_schedules/10512/editpipeline_schedules/10512/edit`, -must have at least Developer access to the project) running on [quality/triage-ops](https://gitlab.com/gitlab-org/quality/triage-ops) +must have at least the Developer role in the project) running on [quality/triage-ops](https://gitlab.com/gitlab-org/quality/triage-ops) project. ## Labels @@ -149,7 +149,7 @@ and `~"group::knowledge"` is picked up by someone in the Access group of the Pla the issue should be relabeled as `~"group::access"` while keeping the original `~"devops::create"` unchanged. -We also use stage and group labels to help measure our [merge request rates](https://about.gitlab.com/handbook/engineering/merge-request-rate/). +We also use stage and group labels to help measure our [merge request rates](https://about.gitlab.com/handbook/engineering/metrics/#merge-request-rate). Please read [Stage and Group labels](https://about.gitlab.com/handbook/engineering/metrics/#stage-and-group-labels) for more information on how the labels are used in this context. ### Category labels diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 783cf7af6fc..a6dcac47910 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -31,7 +31,7 @@ If you are new to GitLab development (or web development in general), see the some potentially easy issues. To start developing GitLab, download the [GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit) -and see the [Development section](../../README.md) for the required guidelines. +and see the [Development section](../../index.md) for the required guidelines. ## Merge request guidelines @@ -158,8 +158,8 @@ Commit messages should follow the guidelines below, for reasons explained by Chr Example commit message template that can be used on your machine that embodies the above (guide for [how to apply template](https://codeinthehole.com/tips/a-useful-template-for-commit-messages/)): ```plaintext -# (If applied, this commit will...) <subject> (Max 50 char) -# |<---- Using a Maximum Of 50 Characters ---->| +# (If applied, this commit will...) <subject> (Max 72 characters) +# |<---- Using a Maximum Of 72 Characters ---->| # Explain why this change is being made diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index 20e47b501e6..5a54e3afbea 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -91,8 +91,32 @@ To skip some checks based on tags when pushing, you can set the `LEFTHOOK_EXCLUD LEFTHOOK_EXCLUDE=frontend,documentation git push ... ``` +As an alternative, you can create `lefthook-local.yml` with this structure: + +```yaml +pre-push: + exclude_tags: + - frontend + - documentation +``` + For more information, check out [Lefthook documentation](https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md#skip-some-tags-on-the-fly). +### Skip or enable a specific Lefthook check + +To skip or enable a check based on its name when pushing, you can add `skip: true` +or `skip: false` to the `lefthook-local.yml` section for that hook. For instance, +you might want to enable the gettext check to detect issues with `locale/gitlab.pot`: + +```yaml +pre-push: + commands: + gettext: + skip: false +``` + +For more information, check out [Lefthook documentation Skipping commands section](https://github.com/evilmartians/lefthook/blob/master/docs/full_guide.md#skipping-commands). + ## Ruby, Rails, RSpec Our codebase style is defined and enforced by [RuboCop](https://github.com/rubocop-hq/rubocop). @@ -128,8 +152,12 @@ reduces the aforementioned [bike-shedding](https://en.wiktionary.org/wiki/bikesh To that end, we encourage creation of new RuboCop rules in the codebase. +We currently maintain Cops across several Ruby code bases, and not all of them are +specific to the GitLab application. 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. +If the Cop targets rules that only apply to the main GitLab application, +it should be added to [GitLab](https://gitlab.com/gitlab-org/gitlab) instead. ### Resolving RuboCop exceptions |