...
- Git commit logs must include the JIRA issue they are addressing. In addition, a useful description must be included, so that
git log
will show useful messages. By convention, commit messages should list the description first with JIRA issue numbers appended in parentheses. If no ticket is relevant to a commit, use "NOJIRA". For example:- Fix normalization of certain attributes during enrollment (CO-155)
- Fix for PHP 7.2 compatibility (NOJIRA)
- JIRA comments must include a brief explanation of what was fixed, to facilitate historical searches. (Simple fixes, such as typos, need no explanation.) JIRA issues must be updated with corresponding SVN commit revision numbers.
- When submitting a Pull Request, add a link the the PR in the JIRA issue (in the comments) to make it easier to track the status of the issue.
...
Error Reporting
There are a number of mechanisms for reporting errors. Which to use depends on context.
...