Best Practice when making changes to an existing plugin

19 views
Skip to first unread message

Jacqueline Taing

unread,
Aug 31, 2015, 5:15:49 PM8/31/15
to Jenkins Developers
Hi,

I am making customizations to the existing Simple Parameterized Build Report plugin to fit our needs: limit number of builds to show to a configurable MAX_DAYS property, change the text of URL in report to include build time and build duration, change URL of builds in report to point to aggregated test results (which uses another plugin).


I have forked the repository in my local workspace but I was wondering what are the general best practices when making extensions to existing plugins:
  1. Do you rename the repository to something else (e.g. simple-parameterized-build-report to something else)
  2. Do you change the plugin name to something else?
  3. What version should be used?
Thanks,
-jacqui

FredG

unread,
Sep 1, 2015, 7:01:36 AM9/1/15
to Jenkins Developers
Hi,

The best practice is to try to add your customizations to the original plugin. If your customizations change existing behavior, add corresponding options.
See also:
https://wiki.jenkins-ci.org/display/JENKINS/Before+starting+a+new+plugin#Beforestartinganewplugin-maintainer

Regards,

Fred
Reply all
Reply to author
Forward
0 new messages