2608e269a5
Add specific code review guidelines See merge request gitlab-org/gitlab-ce!13206 |
||
---|---|---|
.. | ||
fe_guide | ||
img | ||
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 | ||
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 |
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.
- Writing 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
- 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
- Building a package for testing purposes
- Manage feature flags
- View sent emails or preview mailers
Databases
- Merge Request Checklist
- What requires downtime?
- Adding database indexes
- Post Deployment Migrations
- Foreign Keys & Associations
- Serializing Data
- Polymorphic Associations
- Single Table Inheritance
- Background Migrations
- Storing SHA1 Hashes As Binary
- Iterating Tables In Batches
- Ordering Table Columns
- Verifying Database Capabilities
- Hash Indexes
- Swapping Tables
i18n
Compliance
- Licensing for ensuring license compliance