feature-or-bug.rst 882 B

123456789101112131415161718192021222324
  1. ==========================
  2. Is it a feature or a bug ?
  3. ==========================
  4. Sometimes it's a bit tricky to define if given change proposal or change request is adding new feature or fixing existing issue. This document is providing more clarity about categorisation we use.
  5. Bug
  6. ---
  7. Example of bugs:
  8. - crash during application or rule execution
  9. - wrong changes are applied during "fixing codebase" process
  10. - issue with generated report
  11. Feature
  12. -------
  13. Example of features:
  14. - introduction of new rule
  15. - enhancement of existing rule to cover more cases (for example adding support for newly introduced PHP syntax)
  16. - introduction of new ruleset
  17. - update of existing ruleset (for example adjusting it to match newest style of given community or adding newly implemented rule that was supposed to be followed by style of given community, yet not implemented as a rule before)