-
-
Notifications
You must be signed in to change notification settings - Fork 724
Developer Guidelines
Luis Ramos edited this page Jun 18, 2020
·
2 revisions
This page list things you need to know if you are changing specific parts of the app.
Paths for images and icons should be written like this:
- some form of image helper should always be used, there are various helpers depending on the context and desired output, such as: image_tag, image_path, etc...
- paths should be relative to the /app/assets/images folder
- if a path to a static image is not passed to a helper, or is given with a / at the beginning, it will not correctly include the fingerprint, and possibly break
- for example an image under /app/assets/images/home/banner.jpg should be: image_path("home/banner.jpg"). This will correctly add the fingerprint when generating the image URL.
- Rails 4 includes some helpers for use within SASS files as well, check out #image-url
Development environment setup
- Pipeline development process
- Bug severity
- Feature template (epic)
- Internationalisation (i18n)
- Dependency updates
Development
- Developer Guidelines
- The process of review, test, merge and deploy
- Making a great commit
- Making a great pull request
- Code Conventions
- Database migrations
- Testing and Rspec Tips
- Automated Testing Gotchas
- Rubocop
- Angular and OFN
- Feature toggles
- Stimulus and Turbo
Testing
- Testing process
- OFN Testing Documentation (Handbooks)
- Continuous Integration
- Parallelized test suite with knapsack
- Karma
Releasing
Specific features
Data and APIs
Instance-specific configuration
External services
Design