5

Developer Manual

Luis Ramos edited this page 2020-11-28 10:58:32 +00:00

Table of Contents

• Coding Standards

Coding Standards

• Please follow the Ruby on Rails coding standards.

• Have a look at the Development section on the right side menu, there are quite a few pages with standards: developer guidelines, code conventions, rubocop, database migrations, etc.

• We tend to discuss practices in discourse and then move them to this wiki. Some topics are still not described on the wiki, for example, the service naming conventions agreed here.

Home

Development environment setup

• Learning Rails
• Getting started
• Ubuntu
• Debian
• Fedora
• OS X
• Windows
• Docker

Contributing

• 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
• Testing GitHub Actions Locally with act
• 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

• Releasing
• Patch Releases

Specific features

• Sales Tax
• Product amounts units
• Stripe
• Maps

Data and APIs

• API documentation
• Authentication
• Integration & API
• Data migration
• Data model diagram (ERD)
• Stripe
• DFC Guide

Instance-specific configuration

• Locale and sample data
• Troubleshooting your instance

External services

• Setting up Stripe on an OFN instance
• Skylight setup

Design

• Design styleguide: colors and shadows
• Design styleguide: fonts and text styles
• Design styleguide: size and spacing
• Design styleguide: icons
• Design styleguide: links and buttons
• Design styleguide: navigation and menus
• Design styleguide: tables
• Design tools