![]() |
||
---|---|---|
.. | ||
img | ||
ux_guide | ||
README.md | ||
adding_database_indexes.md | ||
api_styleguide.md | ||
architecture.md | ||
changelog.md | ||
ci_setup.md | ||
code_review.md | ||
db_dump.md | ||
doc_styleguide.md | ||
frontend.md | ||
gemfile.md | ||
gitlab_architecture_diagram.png | ||
gitlab_diagram_overview.odg | ||
gotchas.md | ||
instrumentation.md | ||
licensing.md | ||
limit_ee_conflicts.md | ||
merge_request_performance_guidelines.md | ||
migration_style_guide.md | ||
newlines_styleguide.md | ||
object_state_models.md | ||
omnibus.md | ||
performance.md | ||
post_deployment_migrations.md | ||
profiling.md | ||
rake_tasks.md | ||
scss_styleguide.md | ||
shared_files.md | ||
shell_commands.md | ||
sidekiq_debugging.md | ||
sidekiq_style_guide.md | ||
sql.md | ||
testing.md | ||
ui_guide.md | ||
what_requires_downtime.md |
README.md
Development
Outside of docs
- CONTRIBUTING.md main contributing guide
- PROCESS.md contributing process
- GitLab Development Kit (GDK) to install a development version
Styleguides
- API styleguide Use this styleguide if you are contributing to the API.
- Documentation styleguide Use this styleguide if you are contributing to documentation.
- SQL Migration Style Guide for creating safe SQL migrations
- Testing standards and style guidelines
- UX guide for building GitLab with existing CSS styles and elements
- Frontend guidelines
- SQL guidelines for working with SQL queries
- Sidekiq guidelines for working with Sidekiq workers
Gemfile
guidelines
Process
- Generate a changelog entry with
bin/changelog
- Limit conflicts with EE when developing on CE
- Code review guidelines for reviewing code and having code reviewed.
- Merge request performance guidelines for ensuring merge requests do not negatively impact GitLab performance
Backend howtos
- Architecture of GitLab
- CI setup for testing GitLab
- Gotchas to avoid
- How to dump production data to staging
- Instrumentation
- Performance guidelines
- Rake tasks for development
- Shell commands in the GitLab codebase
- Sidekiq debugging
- Object state models
Databases
Compliance
- Licensing for ensuring license compliance