-
Notifications
You must be signed in to change notification settings - Fork 461
Code Style
We are using Rubocop to check the code style. We are following the Rubocop defaults, except the exceptions in .rubocop.yml. We are not following any other style conventions, such as the SUSE style guide.
The decision of adding a new style rule (Rubocop project) is made when updating Rubocop. In the PR for updating it, you can raise you concerns if you don't agree with the default Rubocop configuration. The developers team should reach an agreement about all the new style rules. If an agreement is not possible, the rule will get disabled in .rubocop.yml.
If you don't agree with already agreed style rule, please open an issue to reach a new agreement with the development team. Do not send a PR to change style rules that haven't been accepted.
Note that the offenses in .rubocop_todo.yml, are rules we have already agreed on but that we didn't solve yet (most likely because we didn't have time). That means that those offenses can be solved without a previous discussion. In case that you don't agree with an already introduced style rule, you can open a PR to discuss about it, but do not complain when solving the offenses.
- Development Environment Overview
- Development Environment Tips & Tricks
- Spec-Tips
- Code Style
- Rubocop
- Testing with VCR
- Test in kanku
- Authentication
- Authorization
- Autocomplete
- BS Requests
- Events
- ProjectLog
- Notifications
- Feature Toggles
- Build Results
- Attrib classes
- Flags
- The BackendPackage Cache
- Maintenance classes
- Cloud uploader
- Delayed Jobs
- Staging Workflow
- StatusHistory
- OBS API
- Owner Search
- Search
- Links
- Distributions
- Repository
- Data Migrations
- Package Versions
- next_rails
- Ruby Update
- Rails Profiling
- Remote Pairing Setup Guide
- Factory Dashboard
- osc
- Setup an OBS Development Environment on macOS
- Run OpenQA smoketest locally
- Responsive Guidelines
- Importing database dumps
- Problem Statement & Solution
- Kickoff New Stuff
- New Swagger API doc
- Documentation and Communication
- GitHub Actions
- Brakeman
- How to Introduce Software Design Patterns
- Query Objects
- Services
- View Components
- RFC: Core Components
- RFC: Decorator Pattern
- RFC: Backend models
- RFC: Hotwire Turbo Frames Pattern