raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-01-11 18:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: How to do Code Reviews
Pages
API Development API documentation Angular and OFN Authentication Automated Testing Gotchas Bug severity Bulk Edit Products admin interface Code, the way we do things (2018) Code Conventions Code review process Configuration Continuous Integration Creating new components DFC Guide Data initialization bootstrapping, seeding, and importing data Data migration Data model diagram (ERD) Database migrations Dependency updates Design styleguide: colors and shadows Design styleguide: fonts and text styles Design styleguide: icons Design styleguide: links and buttons Design styleguide: navigation and menus Design styleguide: size and spacing Design styleguide: tables Design tools Developer Guidelines Developer Manual Development Environment Setup: Debian Development Environment Setup: Fedora Development Environment Setup: OS X (El Capitan) Development Environment Setup: OS X (Mavericks) Development Environment Setup: OS X Development Environment Setup: Ubuntu Development Environment Setup: Windows Development Environment Setup: macOS (Sierra, HighSierra, Mojave and Catalina) Docker: useful tips and commands Emails Enterprises login Feature Testing Handbook Feature template (epic) Feature toggle with Flipper Feature toggles Home How to do Code Reviews Integration & API Internationalisation (i18n) Karma Learning Rails Locale and sample data Making a great commit Making a great pull request Maps Matomo Integration Mexico Overview Parallelized test suite with knapsack Patch Releases Permissions Pipeline development process Product amounts units Release testing automation Releasing Rubocop Sales Tax Set and Deploy on Heroku Setting up Stripe in your local environment Setting up Stripe on an OFN instance Skylight setup Slack notifications from GitHub Spree Commerce customisation Staging with Github Actions Stimulus Stripe testing Stripe Tech Doc: App Routes Tech Doc: Checkout workflow Tech Doc: OFN's Spree fork🍴 Tech Doc: OFN Data Model Single shipment per Order Tech Doc: OFN Data Model Stock locations Tech Doc: OFN Data Model Tech Doc: Orders and Adjustments updates Tech Doc: Scoping Variants and Products to Hubs with VariantOverrides Testing GitHub Actions Locally with act Testing Subscriptions Testing and Rspec Tips Testing process The process of review, test, merge and deploy Troubleshooting your instance Turbo Variant Overrides Who i18n
Clone
6
How to do Code Reviews
Dusan Orlovic edited this page 2023-08-23 08:40:41 +02:00

Things you should verify as you code review a PR:

  • Make sure the defined dev process is being followed
  • Make sure the PR is great and that all commits in the PR are great
  • Make sure I18n best practices are followed
  • Make sure the build for the PR is green
  • Make sure the changes are tested at appropriate level (see rspec tips and karma tips for help)
  • Make sure tech best practices are being followed
  • Focus on the implications, design, readability and complexity of the change rather than only its syntax. The latter is what machines are meant to do and that's why we use Rubocop.
  • Make sure code conventions are followed (things Rubocop doesn't check)
  • Make sure the boy scout rule is applied: when changing code, it's important to respect the existing structure, but it's even better when we refactor on the way and improve the code we are changing.

Home

Development environment setup

Contributing

Development

Testing

Releasing

Specific features

Data and APIs

Instance-specific configuration

External services

Design