Skip to content

GitHub Issues

This section documents how we use GitHub Issues to track bugs, feature requests, and other work items for the CNF Odoo project.

Issue Types

Bug Reports

Issues that describe problems or errors in the system: - Unexpected behavior - System errors - Performance problems - Data integrity issues

Feature Requests

New functionality or enhancements to existing features: - New modules or capabilities - UI/UX improvements - Integration requests - Workflow optimizations

Technical Debt

Items that improve code quality without changing functionality: - Refactoring needs - Documentation gaps - Test coverage improvements - Dependency updates

Issue Templates

We use standardized templates to ensure consistent information capture:

Bug Report Template

**Description**
A clear description of the bug

**Steps to Reproduce**
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected Behavior**
What should happen

**Actual Behavior**
What actually happens

**Screenshots**
If applicable, add screenshots

**Environment**
- Odoo Version: [e.g. 13.0]
- Module: [e.g. Purchase]
- Browser: [e.g. Chrome 91]

Feature Request Template

**Is your feature request related to a problem?**
A clear description of the problem

**Describe the solution**
What you want to happen

**Alternatives considered**
Other solutions you've considered

**Additional context**
Any other context or screenshots

Labels

We use a consistent labeling system:

Priority Labels

  • priority: critical - Must be addressed immediately
  • priority: high - Important, address soon
  • priority: medium - Normal priority
  • priority: low - Nice to have

Type Labels

  • type: bug - Something isn't working
  • type: feature - New feature or request
  • type: documentation - Documentation improvements
  • type: maintenance - Code maintenance and cleanup

Status Labels

  • status: triage - Needs review and classification
  • status: confirmed - Issue has been confirmed
  • status: in-progress - Being actively worked on
  • status: blocked - Blocked by dependencies
  • status: review - In code review

Module Labels

  • module: purchase - Purchase module
  • module: inventory - Inventory management
  • module: warehouse - Warehouse operations
  • module: ventor - Ventor mobile app
  • module: integration - External integrations

Workflow

  1. Issue Creation
  2. Use appropriate template
  3. Add initial labels

  4. Assign to project board

  5. Triage

  6. Review new issues weekly
  7. Verify reproduction steps
  8. Set priority and labels

  9. Assign to milestone if applicable

  10. Development

  11. Create branch from issue
  12. Reference issue in commits

  13. Update issue with progress

  14. Resolution

  15. Link pull request to issue
  16. Update documentation if needed
  17. Close issue when merged

Best Practices

  1. Writing Good Issues
  2. Be specific and detailed
  3. Include examples or screenshots
  4. One issue per problem

  5. Search before creating duplicates

  6. Managing Issues

  7. Keep issues updated
  8. Close stale issues
  9. Link related issues

  10. Use milestones for releases

  11. Communication

  12. Tag relevant people
  13. Provide status updates
  14. Ask for clarification when needed
  15. Document decisions in issues