-
-
Notifications
You must be signed in to change notification settings - Fork 725
Home
Welcome to the Developer documentation for Open Food Network! Please read this for an overview of how the software project works and dig into other pages on this wiki for more info.
If you want more generally to understand the OFN project, how the community works and the general processes we have implemented, please check the OFN handbook.
To learn about using the software, see the OFN User Guide.
Tool | Used for.. |
---|---|
Discourse | Forum for in-depth feature discussion, community updates, processes, international conversations. |
Slack | Real-time conversations on development, deployment, features, and other community issues needing synchronous conversations. Use the #dev channel if you need help setting up. |
GitHub | Issues are used for bugs and features from the backlog that will be implemented. The Delivery Board Project gives an overview of the current issues. |
A full set of tools used can be seen on StackShare (setup for UK but similar for most instances).
If you are interested in contributing to the OFN in any capacity, please introduce yourself on Slack, and have a look through the OFN Handbook.
Our GETTING_STARTED and CONTRIBUTING guides are the best place to start for developers looking to set up a development environment and make contributions to the code base.
See the ofn-install wiki where you find guides to install a new server, set up Bugsnag, Google Maps and much more.
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