Template

Difference between revisions of "Bot steps/Documentation"

< Template:Bot steps

(Created page with "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. ==...")
 
(adding translate tags)
Line 1: Line 1:
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.
+
<languages/>
 +
<translate>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 ==
 
== General parameters ==
# <code>isolang</code>: code of the target language.
+
 
# <code>requester</code>: username of the requester.
+
# <tvar|isolang><code>isolang</code></>: code of the target language.
# <code>assigned</code>: username of the developer assigned to the request.
+
# <tvar|requester><code>requester</code></>: username of the requester.
# <code>botmaster</code>: username of the botmaster ([[User:Poslovitch]] by default).
+
# <tvar|assigned><code>assigned</code></>: username of the developer assigned to the request.
 +
# <tvar|botmaster><code>botmaster</code></>: username of the botmaster ([[User:Poslovitch|Poslovitch]] by default).
  
 
== Steps at creation ==
 
== Steps at creation ==
# <code>request</code>: The requester from an external wiki has posted their request on [[LinguaLibre:Bot]]
+
 
# <code>discussion</code>: The request is taken into account, any additional information that would be needed for development is asked to the requester.
+
# <tvar|request><code>request</code></>: The requester from an external wiki has posted their request on <tvar|1>[[LinguaLibre:Bot]]</>
# <code>community-approval</code>: The requester ensures that the community of the target wiki is aware and willing to use LinguaLibreBot.
+
# <tvar|discussion><code>discussion</code></>: The request is taken into account, any additional information that would be needed for development is asked to the requester.
# <code>account</code>: The botmaster creates the local LinguaLibreBot account on the target wiki.
+
# <tvar|community-approval><code>community-approval</code></>: The requester ensures that the community of the target wiki is aware and willing to use LinguaLibreBot.
# <code>code</code>: The developer assigned to the request writes the script.
+
# <tvar|account><code>account</code></>: The botmaster creates the local LinguaLibreBot account on the target wiki.
# <code>test</code>: The developer assigned to the request tested their script on the target wiki.
+
# <tvar|code><code>code</code></>: The developer assigned to the request writes the script.
# <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).
+
# <tvar|test><code>test</code></>: The developer assigned to the request tested their script on the target wiki.
# <code>pr-created</code>: The developer creates the pull request on GitHub.
+
# <tvar|botflag-request><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>botflag-ok</code>: The bot flag for LinguaLibreBot is granted.
+
# <tvar|pr-created><code>pr-created</code></>: The developer creates the pull request on GitHub.
# <code>pr-merged</code>: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
+
# <tvar|botflag-ok><code>botflag-ok</code></>: The bot flag for LinguaLibreBot is granted.
# <code>deployed</code>: The botmaster deploys the target wiki integration on Toolforge.
+
# <tvar|pr-merged><code>pr-merged</code></>: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
# <code>notification</code>: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
+
# <tvar|deployed><code>deployed</code></>: The botmaster deploys the target wiki integration on Toolforge.
# <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.
+
# <tvar|notification><code>notification</code></>: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
 +
# <tvar|tested-real-conditions><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.
  
 
== Template usage ==
 
== Template usage ==
 +
</translate>
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code || Result
 
! Code || Result

Revision as of 09:14, 12 November 2021

Other languages:
Deutsch • ‎English • ‎brezhoneg • ‎français • ‎occitan • ‎sicilianu • ‎svenska • ‎македонски

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

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

Steps at creation

  1. request: The requester from an external wiki has posted their request on LinguaLibre:Bot
  2. discussion: The request is taken into account, any additional information that would be needed for development is asked to the requester.
  3. community-approval: The requester ensures that the community of the target wiki is aware and willing to use LinguaLibreBot.
  4. account: The botmaster creates the local LinguaLibreBot account on the target wiki.
  5. code: The developer assigned to the request writes the script.
  6. test: The developer assigned to the request tested their script on the target wiki.
  7. 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).
  8. pr-created: The developer creates the pull request on GitHub.
  9. botflag-ok: The bot flag for LinguaLibreBot is granted.
  10. pr-merged: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
  11. deployed: The botmaster deploys the target wiki integration on Toolforge.
  12. notification: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
  13. 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
}}


  • [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