Difference between revisions of "Bot steps/text"

Revision as of 08:21, 12 November 2021

[ ] Request opened.
[ ] Requirements defined.
[ ] Script coded.
[ ] Code submited (Pull Request).
[ ] Code accepted.
[ ] Requestee notified.
[ ] Community notified.
[ ] Local help page created.
[ ] 7 days delay.
[ ] Bot activated.

add parameter isolang: add parameter requestee-add parameter botmaster

This template keeps track of the progress on the various steps for bot integration on a new wiki. Actual development might slightly differ from the steps shown here.

General parameters

isolang: code of the target language.
requester: username of the requester.
assigned: username of the developer assigned to the request.
botmaster: username of the botmaster (User:Poslovitch by default).

Steps at creation

request: The requester from an external wiki has posted their request on LinguaLibre:Bot
discussion: The request is taken into account, any additional information that would be needed for development is asked to the requester.
community-approval: The requester ensures that the community of the target wiki is aware and willing to use LinguaLibreBot.
account: The botmaster creates the local LinguaLibreBot account on the target wiki.
code: The developer assigned to the request writes the script.
test: The developer assigned to the request tests their script on the target wiki.
botflag-request: The bot flag for LinguaLibreBot has been requested on the target wiki, either after the tests ran by the developer, or before (in the event that the target wiki requires the intervention of stewarts).
pr-created: The developer creates the pull request on GitHub.
botflag-ok: The bot flag for LinguaLibreBot is granted.
pr-merged: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
deployed: The botmaster deploys the target wiki integration on Toolforge.
notification: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
tested-real-conditions: The bot has been successfully running on the target wiki for more than a week. Integration of the bot is deemed complete.

Template usage

Code

Result

{{Bot cycle
|request=x
|define=x
|code=x
|submit=x
|merge=x
|ping=x
|notification=
|help=
|wait=
|active=

|isolang=ori
|requestee=Psubhashish
|botmaster=Poslovitch,Pamputt
}}

Bot creation's steps

[x] Request opened.
[x] Requirements defined.
[x] Script coded.
[x] Code submited (Pull Request).
[x] Code accepted.
[x] Requestee notified.
[] Community notified.
[] Local help page created.
[] 7 days delay.
[] Bot activated.

add parameter requestee-Poslovitch,Pamputt

@@ Line 25: / Line 25: @@
 |}
 <noinclude>
-The '''steps for bot developements''' are a list of identified, necessary and/or best practice steps in order to develop a proper LinguaLibre bot's localization.
+This template keeps track of the progress on the various '''steps for bot integration''' on a new wiki. Actual development might slightly differ from the steps shown here.
 == General parameters ==
-# <code>isolang</code>: code for the target language.
+# <code>isolang</code>: code of the target language.
-# <code>requestee</code>: username of the requestee.
+# <code>requester</code>: username of the requester.
-# <code>botmaster</code>: username of the botmaster (most recent).
+# <code>assigned</code>: username of the developer assigned to the request.
+# <code>botmaster</code>: username of the botmaster ([[User:Poslovitch]] by default).
 == Steps at creation ==
-# <code>request</code>: Requestee from external wiki post a request on [[LinguaLibre:Bot]]
+# <code>request</code>: The requester from an external wiki has posted their request on [[LinguaLibre:Bot]]
-# <code>discuss</code>: Discuss the localized requirements
+# <code>discussion</code>: The request is taken into account, any additional information that would be needed for development is asked to the requester.
-# <code>code</code>: Develop the script
+# <code>community-approval</code>: The requester ensures that the community of the target wiki is aware and willing to use LinguaLibreBot.
-# <code>test</code>: Test the script, runs under close supervision, bot master awaiting feedbacks and ready to fix.
+# <code>account</code>: The botmaster creates the local LinguaLibreBot account on the target wiki.
-# <code>pullrequest</code>: Review the Pull Request
+# <code>code</code>: The developer assigned to the request writes the script.
-# <code>merge</code>: Merge the Pull Request
+# <code>test</code>: The developer assigned to the request tests their script on the target wiki.
-# <code>ping</code>: Requestee get notified : all is ready
+# <code>botflag-request</code>: The bot flag for LinguaLibreBot has been requested on the target wiki, either after the tests ran by the developer, or before (in the event that the target wiki requires the intervention of stewarts).
-# <code>help</code>: Requestee or else creates a local <nowiki>[[Help:LinguaLibre]]</nowiki> on target wiki. This page contains and extremely brief, general purpose definition of LinguaLibre, the bot, as well as a redirect toward support: [[LinguaLibre:Bot]].
+# <code>pr-created</code>: The developer creates the pull request on GitHub.
-# <code>notification</code>: Requestee posts on his local wiki's forum a variation of the following...<br>''<nowiki>== Lilibot coming ==</nowiki><br>Hi everyone. A while back we noticed LinguaLibre, a Wikimedia project, have been uploading load of audio recording in {language}. Adding those audios to our wiki can be supported by their bot, LinguaLibre Bot. Also, we engaged with their team to tinker their bot for that purpose. We are waiting the green lights from the developer, testing via small edits, and we will run this bot in few a few weeks. Also, please if you see edits coming in from "LinguaLibre bot", thanks to sample its edits, and report to us <nowiki>[[:LinguaLibre:LinguaLibre:Bot]]</nowiki> for Q&A or else. Do I forget something ? A place where to also announce this arrival ? Please tell me. Sincerely <nowiki>~~~~</nowiki> and the LinguaLibre's team ;)"''
+# <code>botflag-ok</code>: The bot flag for LinguaLibreBot is granted.
-# <code>wait</code>: Wait 7 days (recommended).
+# <code>pr-merged</code>: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
-# <code>active</code>: Activate the bot with edit msg linking to the <code>help</code> page.
+# <code>deployed</code>: The botmaster deploys the target wiki integration on Toolforge.
+# <code>notification</code>: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
-== Steps along life ==
+# <code>tested-real-conditions</code>: The bot has been successfully running on the target wiki for more than a week. Integration of the bot is deemed complete.
-Other status are also possible :
-* <code>paused</code>: when a bot had already been created, demonstrated, but is in pause. With a comment.
-* <code>blocked</code>: when the bot is blocked, for various reason. Please notify [[LinguaLibre:Bot]] and point to the relevant discussions.
-* <code>test</code>: bot returns in test phase.
-* <code>retired</code>: when a bot is retired.
 == Template usage ==