Hi Devs,

I just wanted to drop a note on how to properly reference issues using
standard naming conventions for the various issue trackers we have
used for Accumulo development at ASF. Since we have old issues on
JIRA, but for the most part have transitioned to using GitHub issues
as our issue tracker, there have been some confusing references to
issues on one system, but using the other's naming convention. This
can cause problems, for example, because if you reference an issue by
the JIRA convention, ASF's infrastructure will add a log message on
that JIRA... even though it is completely unrelated to the GitHub
issue you are referencing. This can be very confusing when you get a
notification from JIRA about an old issue long since closed.

So, the proper convention for referencing an issue is:

on GitHub:
    #NNNN or org/repo#NNNN
    (example: #1644 or apache/accumulo#1644)

on JIRA:
    ACCUMULO-NNNN
    (example: ACCUMULO-1644)

Please use the issue naming convention appropriate for the system you
are referencing at all times, including naming your git working
branches, because *any* time these references show up on our mailing
lists, in our git logs, in pull requests, or on GitHub or JIRA
comments, it can result in significant confusion for both humans and
automated systems (such as ASFs pubsub systems).

Thanks,

Christopher

Reply via email to