0364e07447
Signed-off-by: Rémy Coutable <remy@rymai.me> |
||
---|---|---|
.. | ||
fe_guide | ||
i18n | ||
img | ||
testing_guide | ||
ux_guide | ||
adding_database_indexes.md | ||
api_styleguide.md | ||
architecture.md | ||
background_migrations.md | ||
build_test_package.md | ||
changelog.md | ||
code_review.md | ||
database_merge_request_checklist.md | ||
db_dump.md | ||
doc_styleguide.md | ||
emails.md | ||
feature_flags.md | ||
foreign_keys.md | ||
frontend.md | ||
gemfile.md | ||
gitaly.md | ||
gitlab_architecture_diagram.png | ||
gitlab_diagram_overview.odg | ||
gotchas.md | ||
hash_indexes.md | ||
i18n_guide.md | ||
instrumentation.md | ||
iterating_tables_in_batches.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 | ||
ordering_table_columns.md | ||
performance.md | ||
policies.md | ||
polling.md | ||
polymorphic_associations.md | ||
post_deployment_migrations.md | ||
profiling.md | ||
query_recorder.md | ||
rake_tasks.md | ||
README.md | ||
serializing_data.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 | ||
verifying_database_capabilities.md | ||
what_requires_downtime.md | ||
writing_documentation.md |
GitLab development guides
Get started!
- Setup 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.
- Limit conflicts with EE when developing on CE
UX and frontend guides
- UX guide for building GitLab with existing CSS styles and elements
- Frontend guidelines
Backend guides
- API styleguide Use this styleguide if you are contributing to the API.
- Sidekiq guidelines for working with Sidekiq workers
- Working with Gitaly
- Manage feature flags
- View sent emails or preview mailers
- Shell commands in the GitLab codebase
Gemfile
guidelines- Sidekiq debugging
- Gotchas to avoid
- Issue and merge requests state models
- How to dump production data to staging
Performance guides
- Instrumentation
- Performance guidelines
- Merge request performance guidelines for ensuring merge requests do not negatively impact GitLab performance
Databases guides
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
Best practices
- Merge Request checklist
- Adding database indexes
- Foreign keys & associations
- Single table inheritance
- Polymorphic associations
- Serializing data
- Hash indexes
- Storing SHA1 hashes as binary
- Iterating tables in batches
- Ordering table columns
- Verifying database capabilities
Testing guides
Documentation guides
- Documentation styleguide: Use this styleguide if you are contributing to the documentation.
- Writing documentation
Internationalization (i18n) guides
Build guides
Compliance
- Licensing for ensuring license compliance