On 11/24/2022 3:44 PM, David Marchand wrote: > From: Bruce Richardson <bruce.richard...@intel.com> > > Since a number of contributors to DPDK have submitted patches to DPDK > under more than one email address, we should maintain a mailmap file to > properly track their commits using "shortlog". > > It also helps fix up any mangled names, for example, with > surname/firstname reversed, or with incorrect capitalization. > By keeping this file in the DPDK repository, rather than committers > maintaining their own copies, it allows individual contributors to edit > it to update their own email address preferences if so desired. > > While at it, update our checkpatches.sh script and add some > documentation to help new contributors. > > Signed-off-by: Bruce Richardson <bruce.richard...@intel.com> > Signed-off-by: David Marchand <david.march...@redhat.com>
<...> > @@ -148,6 +148,9 @@ Make your planned changes in the cloned ``dpdk`` repo. > Here are some guidelines > > * Follow the :ref:`coding_style` guidelines. > > +* If you are a new contributor, or if your mail address changed, please > update the ``.mailmap`` file. There is no benefit for new contributors to update .mailmap file, but it adds another thing to update. I think it is simpler to keep .mailmap only for users that has multiple email address in the git repo, and ask only from contributors in this catagory to update the .mailmap instead of all contributors. > + This will help other developers when they want to contact you on changes > you contributed to. > + > * If you add new files or directories you should add your name to the > ``MAINTAINERS`` file. > > * Initial submission of new PMDs should be prepared against a corresponding > repo.
