kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss

History

Robert Speicher 985737fdcf Merge branch 'docs/30141-improve-contributing-guide' into 'master' Resolve "Combine all GitLab workflow documentation to CONTRIBUTING.md" Closes #30141 See merge request !10991		2017-05-04 14:14:25 +00:00
..
fe_guide	Merge branch 'vue-experts' into 'master'	2017-04-24 20:01:32 +00:00
img	Add long polling diagrams	2017-03-31 21:51:30 -07:00
ux_guide	Improve UX guide on tooltips	2017-03-27 16:25:26 +01:00
adding_database_indexes.md
api_styleguide.md
architecture.md
changelog.md	Expand on the good changelog/bad changelog documentation examples	2017-03-16 12:56:41 -04:00
code_review.md	Improving copy of CONTRIBUTING.md, PROCESS.md, and code_review.md	2017-05-04 09:02:39 +02:00
db_dump.md
doc_styleguide.md	add directory `articles` to hold all tech articles	2017-04-17 17:44:22 -03:00
frontend.md	Creates Frontend Style guide	2017-03-22 19:30:54 +00:00
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	Adds docs for QueryRecorder tests	2017-03-13 18:59:36 +00:00
migration_style_guide.md	Add some documentation for the new migration helpers	2017-05-02 14:10:55 +02:00
newlines_styleguide.md
object_state_models.md
omnibus.md
performance.md	Adds docs for QueryRecorder tests	2017-03-13 18:59:36 +00:00
polling.md	Document how polling interval is used	2017-04-10 16:52:25 +02:00
post_deployment_migrations.md
profiling.md	Adds docs for QueryRecorder tests	2017-03-13 18:59:36 +00:00
query_recorder.md	Adds docs for QueryRecorder tests	2017-03-13 18:59:36 +00:00
rake_tasks.md	Elaborate on the usage of Spring	2017-05-03 12:09:47 +02:00
README.md	Remove outdated ci_setup.md doc page and document MySQL and RSpec profiling for specific branches	2017-04-25 20:40:44 +02:00
shared_files.md
shell_commands.md
sidekiq_debugging.md
sidekiq_style_guide.md
sql.md
testing.md	Enable `RSpec/DescribedClass` cop	2017-05-01 11:12:13 -04:00
ui_guide.md
what_requires_downtime.md	Prepare for zero downtime migrations	2017-04-12 18:15:19 +02:00
writing_documentation.md	Document the process of docs only changes	2017-04-28 12:08:50 +02:00

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.
Writing documentation
- Distinction between general documentation and technical articles
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

Databases

Compliance

Licensing for ensuring license compliance