I don't think it's mandatory, just good practice. Although i have a general idea of what your plugin does by looking at the code. If your codebase grew and the complexity was higher, having a short descriptive readme file makes it easier for the folks responsible for forking it on jenkinsci to determine whether the plugins functionality could be merged into existing plugins.
On Tue, Feb 17, 2015 at 11:41 AM, Nitzan Raz <[email protected]> wrote: > I'm going to. Didn't see it on my inspiration plugin > <https://github.com/jenkinsci/matrix-auth-plugin>, so I assumed it was > not-mandatory. > > *Nitzan Raz* > http://backslasher.net > > On Tue, Feb 17, 2015 at 12:40 PM, Mads Nielsen <[email protected]> wrote: > >> It's usually a good idea to provide a short descriptive readme.md file >> in the root of your repository with a short description / statement of the >> purpose your plugin serves. >> >> >> >> On Tue, Feb 17, 2015 at 11:35 AM, Nitzan Raz <[email protected]> wrote: >> >>> Hi All >>> I developed a new plugin and wanted to contribute it, according to this >>> <https://wiki.jenkins-ci.org/display/JENKINS/Hosting+Plugins> >>> >>> Plugin is based on standard procedure, pom file is complete because I >>> didn't know how to fill the "@jenkinsci" part. >>> >>> My plugin name: "jenkins-lockdown-fullcontrol-auth-plugin" (Lockdown >>> Logged-in Authorization Startegy) >>> Personal github ID: BackSlasher >>> Existing repo: >>> https://github.com/BackSlasher/jenkins-lockdown-fullcontrol-auth-plugin.git >>> >>> If some info is missing / the plugin sucks and cannot be possibly >>> accepted please LMK >>> >>> Thanks >>> >>> *Nitzan Raz* >>> http://backslasher.net >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "Jenkins Developers" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to [email protected]. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/jenkinsci-dev/CAD%2BnROA0LDFn_6FOgEjaoZQvPSsHZEHKcSzOj%2B%2Bq0vqyCKCT%2BQ%40mail.gmail.com >>> <https://groups.google.com/d/msgid/jenkinsci-dev/CAD%2BnROA0LDFn_6FOgEjaoZQvPSsHZEHKcSzOj%2B%2Bq0vqyCKCT%2BQ%40mail.gmail.com?utm_medium=email&utm_source=footer> >>> . >>> For more options, visit https://groups.google.com/d/optout. >>> >> >> >> >> -- >> [image: ____________________________________________________________] >> Mads Nielsen >> Consultant >> [email protected] >> +45 50 98 18 09 >> Skype: inkspot >> Praqma >> www.praqma.com >> Allerød Stationsvej 4 >> DK-3450 Allerød >> +45 36 77 27 62 >> >> -- >> You received this message because you are subscribed to the Google Groups >> "Jenkins Developers" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/jenkinsci-dev/CAFariutZpAjN5QYwnk1fz5v-817d4BFyZ_ZNa9iKp%3DxKpdyZ7A%40mail.gmail.com >> <https://groups.google.com/d/msgid/jenkinsci-dev/CAFariutZpAjN5QYwnk1fz5v-817d4BFyZ_ZNa9iKp%3DxKpdyZ7A%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> For more options, visit https://groups.google.com/d/optout. >> > > -- > You received this message because you are subscribed to the Google Groups > "Jenkins Developers" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/jenkinsci-dev/CAD%2BnROBvtCgyctb%3Dh-TQ9v9Zo_DKA7839P9RL%3Dc2Hy0b9HXT0Q%40mail.gmail.com > <https://groups.google.com/d/msgid/jenkinsci-dev/CAD%2BnROBvtCgyctb%3Dh-TQ9v9Zo_DKA7839P9RL%3Dc2Hy0b9HXT0Q%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > > For more options, visit https://groups.google.com/d/optout. > -- [image: ____________________________________________________________] Mads Nielsen Consultant [email protected] +45 50 98 18 09 Skype: inkspot Praqma www.praqma.com Allerød Stationsvej 4 DK-3450 Allerød +45 36 77 27 62 -- You received this message because you are subscribed to the Google Groups "Jenkins Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAFariuv9fw7OCWg8VfrSk0JCYo6c2%3DygtG0fecWAs1-apRZssw%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
