e5af7d8396
The new version requires `python3` to be available. In omnibus installation this is already a reality as we are currently pathing previous `gitlab-markup` version to use `python3` instead of `python2`. We are now requiring `python3` with the gem without having to patch it. As a consequence to also make it easy to use it in development, we've introduced a `Pipfile` and `Pipfile.lock`, working similarly to `Gemfile` and `Gemfile.lock`, and added documentation on how to use them.
2 KiB
2 KiB
Style guides
- Ruby.
Important sections include Source Code Layout and
Naming. Use:
- multi-line method chaining style Option A: dot
.on the second line - string literal quoting style Option A: single quoted by default
- multi-line method chaining style Option A: dot
- Rails
- Newlines styleguide
- Testing
- JavaScript styleguide
- SCSS styleguide
- Shell commands created by GitLab contributors to enhance security
- Database Migrations
- Markdown
- Documentation styleguide
- Interface text should be written subjectively instead of objectively. It should be the GitLab core team addressing a person. It should be written in present time and never use past tense (has been/was). For example instead of prohibited this user from being saved due to the following errors: the text should be sorry, we could not create your account because:
- Code should be written in US English
- Go
- Python
This is also the style used by linting tools such as RuboCop and Hound CI.