History

Mark Florian 05ec97d403 Apply review suggestions - Reword relationship between Jest/Karma/Jasmine - Prefer inline URLs, per the [docs] [docs]: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links		2019-08-29 06:43:25 +00:00
..
contributing	…
documentation	…
fe_guide	…
feature_flags	…
go_guide	…
i18n	…
img	…
integrations	…
new_fe_guide	…
python_guide	…
shell_scripting_guide	…
testing_guide	Apply review suggestions	2019-08-29 06:43:25 +00:00
ux_guide	Update a few redirected links	2019-08-29 05:22:27 +00:00
README.md	…
adding_database_indexes.md	…
api_graphql_styleguide.md	…
api_styleguide.md	…
architecture.md	…
automatic_ce_ee_merge.md	…
background_migrations.md	…
build_test_package.md	…
changelog.md	…
chaos_endpoints.md	…
chatops_on_gitlabcom.md	…
code_comments.md	…
code_review.md	…
database_debugging.md	…
database_helpers.md	…
database_merge_request_checklist.md	…
database_review.md	…
db_dump.md	…
diffs.md	…
distributed_tracing.md	…
doc_styleguide.md	…
ee_features.md	…
elasticsearch.md	…
emails.md	…
feature_flags.md	…
file_storage.md	…
filtering_by_label.md	…
foreign_keys.md	…
frontend.md	…
gemfile.md	…
geo.md	…
git_object_deduplication.md	…
gitaly.md	…
github_importer.md	…
gitlab_diagram_overview.odg	…
gotchas.md	…
hash_indexes.md	…
i18n_guide.md	…
import_export.md	…
instrumentation.md	…
interacting_components.md	…
iterating_tables_in_batches.md	…
kubernetes.md	…
lfs.md	…
licensed_feature_availability.md	…
licensing.md	…
logging.md	…
merge_request_performance_guidelines.md	…
migration_style_guide.md	…
module_with_instance_variables.md	…
namespaces_storage_statistics.md	…
newlines_styleguide.md	…
omnibus.md	…
ordering_table_columns.md	…
packages.md	…
performance.md	…
permissions.md	…
policies.md	…
polling.md	…
polymorphic_associations.md	…
post_deployment_migrations.md	…
profiling.md	…
prometheus_metrics.md	…
pry_debugging.md	…
query_count_limits.md	…
query_recorder.md	…
rake_tasks.md	…
repository_mirroring.md	…
reusing_abstractions.md	…
rolling_out_changes_using_feature_flags.md	…
routing.md	…
serializing_data.md	…
session.md	…
sha1_as_binary.md	…
shared_files.md	…
shell_commands.md	…
sidekiq_debugging.md	…
sidekiq_style_guide.md	…
single_table_inheritance.md	…
sql.md	…
swapping_tables.md	…
testing.md	…
ui_guide.md	…
understanding_explain_plans.md	…
uploads.md	…
utilities.md	…
verifying_database_capabilities.md	…
what_requires_downtime.md	…
writing_documentation.md	…

README.md

comments	description
false	Learn how to contribute to GitLab.

Contributor and Development Docs

Get started

Set up GitLab's development environment with GitLab Development Kit (GDK)
GitLab contributing guide
Architecture of GitLab
Rake tasks for development

Processes

GitLab core team & GitLab Inc. contribution process
Generate a changelog entry with bin/changelog
Code review guidelines for reviewing code and having code reviewed
Database review guidelines for reviewing database-related changes and complex SQL queries
Automatic CE->EE merge
Guidelines for implementing Enterprise Edition features
Security process for developers
Requesting access to Chatops on GitLab.com (for GitLabbers)

UX and Frontend guides

GitLab Design System for building GitLab with existing CSS styles and elements
Frontend guidelines
Emoji guide

Backend guides

GitLab utilities
Logging
API styleguide Use this styleguide if you are contributing to the API
GraphQL API styleguide Use this styleguide if you are contributing to the GraphQL API
Sidekiq guidelines for working with Sidekiq workers
Working with Gitaly
Manage feature flags
Licensed feature availability
View sent emails or preview mailers
Shell commands in the GitLab codebase
Gemfile guidelines
Pry debugging
Sidekiq debugging
Accessing session data
Gotchas to avoid
Avoid modules with instance variables if possible
How to dump production data to staging
Working with the GitHub importer
Import/Export development documentation
Elasticsearch integration docs
Working with Merge Request diffs
Kubernetes integration guidelines
Permissions
Prometheus metrics
Guidelines for reusing abstractions
DeclarativePolicy framework
How Git object deduplication works in GitLab
Geo development
Routing
Repository mirroring
Git LFS
Developing against interacting components or features
File uploads

Performance guides

Instrumentation for Ruby code running in production environments
Performance guidelines for writing code, benchmarks, and certain patterns to avoid
Merge request performance guidelines for ensuring merge requests do not negatively impact GitLab performance
Profiling a URL, measuring performance using Sherlock, or tracking down N+1 queries using Bullet

Database guides

Tooling

Understanding EXPLAIN plans
explain.depesz.com for visualising the output of EXPLAIN
pgFormatter a PostgreSQL SQL syntax beautifier

Migrations

What requires downtime?
SQL guidelines for working with SQL queries
Migrations style guide for creating safe SQL migrations
Post deployment migrations
Background migrations
Swapping tables

README.md

Contributor and Development Docs

Get started

Processes

UX and Frontend guides

Backend guides

Performance guides

Database guides

Tooling

Migrations

Best practices

Case studies

Integration guides

Testing guides

Documentation guides

Internationalization (i18n) guides

Build guides

Compliance

Go guides

Shell Scripting guides

Other GitLab Development Kit (GDK) guides