BigW Consortium Gitlab

README.md 2.12 KB
Newer Older
1
# Development
2

3 4 5 6
## Outside of docs

- [CONTRIBUTING.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) main contributing guide
- [PROCESS.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) contributing process
7
- [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md) to install a development version
8 9 10

## Styleguides

Rémy Coutable committed
11 12
- [API styleguide](api_styleguide.md) Use this styleguide if you are
  contributing to the API.
13
- [Documentation styleguide](doc_styleguide.md) Use this styleguide if you are
14
  contributing to documentation.
15
- [SQL Migration Style Guide](migration_style_guide.md) for creating safe SQL migrations
16
- [Testing standards and style guidelines](testing.md)
17
- [UX guide](ux_guide/index.md) for building GitLab with existing CSS styles and elements
18
- [Frontend guidelines](frontend.md)
19 20
- [SQL guidelines](sql.md) for working with SQL queries
- [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers
21 22 23

## Process

24
- [Generate a changelog entry with `bin/changelog`](changelog.md)
25
- [Limit conflicts with EE when developing on CE](limit_ee_conflicts.md)
26
- [Code review guidelines](code_review.md) for reviewing code and having code reviewed.
27 28
- [Merge request performance guidelines](merge_request_performance_guidelines.md)
  for ensuring merge requests do not negatively impact GitLab performance
29 30 31

## Backend howtos

32
- [Architecture](architecture.md) of GitLab
Dmitriy Zaporozhets committed
33
- [CI setup](ci_setup.md) for testing GitLab
34
- [Gotchas](gotchas.md) to avoid
35
- [How to dump production data to staging](db_dump.md)
36
- [Instrumentation](instrumentation.md)
37
- [Performance guidelines](performance.md)
38 39
- [Rake tasks](rake_tasks.md) for development
- [Shell commands](shell_commands.md) in the GitLab codebase
40
- [Sidekiq debugging](sidekiq_debugging.md)
41
- [Object state models](object_state_models.md)
42 43 44

## Databases

45
- [What requires downtime?](what_requires_downtime.md)
46
- [Adding database indexes](adding_database_indexes.md)
47
- [Post Deployment Migrations](post_deployment_migrations.md)
48 49 50 51

## Compliance

- [Licensing](licensing.md) for ensuring license compliance