Contributing [contributing]

How to work inside the {{kib}} repository: the development principles we hold, the day-to-day GitHub workflow, the layout of the codebase, the rules for HTTP API design, and how the build and CI pipeline work.

Principles

How we think about quality, security, accessibility, performance, and i18n when writing code. Start here if you're new to the project.

• Developer principles
• Security
• Accessibility
• Internationalization
• Performance
• Standards and guidelines

Workflow

How we use GitHub, submit and review pull requests, file issues, and plan feature work.

• How we use GitHub
• Submitting a pull request
• Pull request review guidelines
• Effective issue reporting
• Feature development

Codebase

Repository layout, TypeScript project references, linting, internal documentation, dependency management, and platform-wide concerns like logging and saved objects.

• Repository structure
• TypeScript project references
• Kibana linting
• Documentation
• Managing third-party dependencies
• Upgrading Node.js
• Logging
• Saved objects and migrations
• Runtime constraints
• Package design

API design

Conventions for designing HTTP APIs in {{kib}}, including Terraform-friendly patterns.

• Guidelines for HTTP API design in Kibana
• Guidelines for Terraform-friendly HTTP APIs

CI and build

How {{kib}}'s Buildkite CI works, how to build a distributable, and how to debug failures (including FIPS-mode test failures).

• CI
• Building a Kibana distributable
• Debugging in development
• Debugging FIPS test failures