Difference between revisions of "The Test Team Handbook"

From EncyclopAtys

Jump to: navigation, search
m
 
(47 intermediate revisions by 5 users not shown)
Line 1: Line 1:
βˆ’
{{WIP}}
 
 
{{Trad  
 
{{Trad  
βˆ’
|DE =The Test Team Handbook
+
|DE =Das Test-Team-Handbuch|DEs=4
βˆ’
|EN =The Test Team Handbook
+
|EN =The Test Team Handbook|ENs=0
βˆ’
|ES =The Test Team Handbook
+
|ES =The Test Team Handbook|ESs=5
βˆ’
|FR =The Test Team Handbook
+
|FR =Manuel de l'Γ©quipe de test|FRs=5
βˆ’
|RU =The Test Team Handbook
+
|RU =The Test Team Handbook|RUs=5
 
|H  =
 
|H  =
 
|palette=Grey
 
|palette=Grey
 
}}
 
}}
 +
This document gives you quick overview about necessary steps you must undertake to join the [[Test Team]] and be able to do good work. It is enriched with links to other documents with more details in case such text exists. If you have any questions or suggestions, feel free ask on [https://chat.ryzom.com/group/chat-general #chat-general] (accessible for team members only) or [https://chat.ryzom.com/channel/pub-general #pub-general] (open for everybody).
  
βˆ’
# Joining the Test team:<br />  https://cloud.ryzom.com/f/34474
+
=Step 1: Apply to join=
βˆ’
# - External team tools:<br /> https://cloud.ryzom.com/f/34471
+
If you are willing to apply to become a member of the Testing team, please contact Tamarea, directly on [https://chat.ryzom.com/direct/Tamarea Ryzom chat] or by sending an e-mail to [mailto:tamarea@ryzom.com tamarea@ryzom.com]. You need to get access to team tools and private chat rooms. After this step use the [https://chat.ryzom.com/group/t-test #t-test] chat room for any questions related to testing.
βˆ’
# - Setting up connection to non-public Ryzom servers: <br />https://cloud.ryzom.com/f/34233
 
βˆ’
# - On a testing server: <br />https://cloud.ryzom.com/f/34472
 
  
 +
'''More information:''' [[The Test Team Handbook/1 - Get in touch with Ryzom Forge|Get in touch with Ryzom Forge]]
  
βˆ’
=Joining the Test team=
+
=Step 2: Get familiar with team tools=
βˆ’
This document gives you quick overview about necessary steps you must undertake to join the Testing team. It is enriched with links to other documents with more details in case such text exists. If you have any questions or suggestions, feel free ask on #chat-general (accessible for team members only) or #pub-general (open for everybody).
+
As next you need to become familiar with tools used by the Ryzom team. For planning we use Kan Board, for collaboration we have a cloud system and internal (team) chat rooms.
  
βˆ’
==Apply to join==
+
'''More information:''' [[The Test Team Handbook/2 - External team tools|External team tools]]
βˆ’
If you are willing to apply to become a member of the Testing team, please contact [[User:Tamarea|Tamarea]], directly on Ryzom chat or by sending an e-mail to tamarea@ryzom.com. You need to get access to team tools and private chat rooms. After this step use the #t-test chat room for any questions related to testing.
 
βˆ’
More information: Get in touch with Ryzom Forge
 
  
βˆ’
==Get familiar with team tools==
+
=Step 3: Configure Ryzom clients=
βˆ’
As next you need to become familiar with tools used by the Ryzom team. For planning we use Kan Board, for collaboration we have a cloud system and internal (team) chat rooms.
+
The most of team work and testing is closely tight to our testing servers. You need to create two separated client installations to have access to Yubo, the developers server, Gingo, the testing server and also to beta updates for Atys server.
βˆ’
More information: External team tools
 
  
βˆ’
==Configure Ryzom clients==
+
'''More information:''' [[The Test Team Handbook/3 - Setting up connection to non-public Ryzom servers|Setting up connection to non-public Ryzom servers]]
βˆ’
The most of team work and testing is closely tight to our testing servers. You need to create two separated client installations to have access to Yubo, the developers server, and Gingo, the testing server.
 
βˆ’
More information: Setting up connection to non-public Ryzom servers
 
  
βˆ’
==Prepare for testing==
+
=Step 4: Prepare for testing=
 
Once you have access to testing servers, you need to prepare some characters to perform tests and become familiar with in-game tools for testers. It will make your life much easier.
 
Once you have access to testing servers, you need to prepare some characters to perform tests and become familiar with in-game tools for testers. It will make your life much easier.
βˆ’
More information: On a testing server
 
βˆ’
 
βˆ’
==Learn some theory of testing==
 
βˆ’
Your work in the Test team is mostly up to you. You are free to join any test and you can use any procedure that fits you. However there are some rules that help cooperation with others, prevents fails. You need to get familiar with some aspects of the testing to make sure your reports and your results will be useful for others.
 
βˆ’
 
βˆ’
<big>'''More information: (to be written)'''</big>
 
βˆ’
 
βˆ’
=External team tools=
 
βˆ’
This document shortly describes external tools that are useful for every team member. These tools are not working in-game or just in a very limited way and you need to use external browser. The goal is not to supply any user manual just give you a basic overview about what do we use, how it could be useful and how to log in. The second part of this document is focused on memers of the Testing team.
 
βˆ’
 
βˆ’
==General information==
 
βˆ’
Here is a basic description of all important external tools that you should keep in mind and use.
 
βˆ’
 
βˆ’
===Ryzom chat (RC)===
 
βˆ’
You probably know the Ryzom chat already. It is a tool that allows you to read in-game chats without a need to be actually in game. You will have "~" (tilda) prefix in front of your name in case of every message sent from RC to the game. Some additional details about Ryzom chat are described in the RC FAQ article on the Ryzom Wiki.
 
βˆ’
Another important role of the Ryzom chat is also that each team or project members have own chat room available. By default every team member supposed be member of following rooms: #announcement, #chat-general and #chat-ark_dev. Team chat rooms have a "t-" prefix and project chat rooms have "pj-" prefix.
 
βˆ’
Internal chat rooms are not public thus you must become a member of a team/project first to see other private rooms then default ones. In all cases if you think you have lost or didn't get access to a specific channel (including default ones) you should be presented on please contact [[User:Tamarea|Tamarea]] or Tykus.
 
βˆ’
*'''URL''': https://chat.ryzom.com
 
βˆ’
*'''Login''': your character name
 
βˆ’
*'''Password''': your account password
 
βˆ’
*'''Permissions by''': [[User:Tamarea|Tamarea]] or [[User:Tykus|Tykus]]
 
βˆ’
 
βˆ’
===KanBoard (KB)===
 
βˆ’
KanBoard is a collaboration tool, a place where all team tasks supposed to be registered. There exists a lot of boards for various teams, projects and use. The general rule about tasks is that they travel from columns on left to columns on right as they progress. In case you miss access to any board you supposed to see please contact [[User:Tamarea|Tamarea]].
 
βˆ’
*'''URL''': https://board.ryzom.com
 
βˆ’
*'''Login''': your account name
 
βˆ’
*'''Password''': your account password
 
βˆ’
*'''Permissions by:''' [[User:Tamarea|Tamarea]]
 
βˆ’
 
βˆ’
===Ryzom cloud (Cloud)===
 
βˆ’
Ryzom cloud is a powerful tool for (not just) collaboration on documents. There are various folders and the visibility depends on your team or project membership as usually. You can work with various file types on the cloud. However, for team cooperation we use mostly Pads, a special type of document that highlights different contributors. In case you miss access to any part of the cloud please contact [[User:Tamarea|Tamarea]]. Some additional details about file formats used on the Ryzom cloud are described on the Ryzom Wiki.
 
βˆ’
There is a "Ryzom-Team" folder on the cloud that you should be able to access. You can find some useful documents for internal needs, sorted to several sub-folders.
 
βˆ’
*'''URL''': https://cloud.ryzom.com
 
βˆ’
*'''Login''': your account name
 
βˆ’
*'''Password''': your account password
 
βˆ’
*'''Permissions by''': [[User:Tamarea|Tamarea]]
 
βˆ’
 
βˆ’
===Ryzom Wiki===
 
βˆ’
Ryzom wiki is the main place for all documentation. It is not a tool you will probably need to use directly in your team. However, it contains a lot of useful information about the game and its world. The Wiki is maintained by the Ryzom Wiki project. Viewing documents does not require any authentication. However, you must have an account in case you wish to contribute.
 
βˆ’
*'''URL''': https://wiki.ryzom.com
 
βˆ’
*'''Login''': your character name
 
βˆ’
*'''Password''': specific for the wiki
 
βˆ’
*'''Permissions by''': [[User:Zorroargh|Zorroargh]]
 
βˆ’
 
βˆ’
===Server status===
 
βˆ’
This small application is used to quickly check the state of all three servers. There is no need to authenticate yourself and it is a passive too that displays what is running and what is not. Please remember that this tool is unable to cover the wrong functionality of a component, it just tells you if it is running or not. In the best case all icons on this page are green (thus everything is running).
 
βˆ’
*'''URL''': https://app.ryzom.com/app_server_status/
 
βˆ’
*'''Login''': not needed
 
βˆ’
*'''Password''': not needed
 
βˆ’
*'''Permissions by''': not needed
 
βˆ’
 
βˆ’
 
βˆ’
==As a member of the Testing team==
 
βˆ’
Here are some additional details for members of the Testing team.
 
  
βˆ’
===Ryzom chat (RC)===
+
'''More information:''' [[The Test Team Handbook/4 - On a testing server|On a testing server]]
βˆ’
You supposed to see #t-test room by default and all discussion about testing supposed to go there, unless you need to interact with members from other teams. Feel free to ask about everything that is not clear, about your work in team, tools, a test details or your questions and issues that appeared during your testing. Feel free to suggest anything that will help run the team or fix any issue you have discovered.
 
  
βˆ’
===KanBoard (KB)===
+
=Step 5: Choose a test=
βˆ’
You supposed to see "[Team] Test" board where all current or near-future tests have a place. The board is separated to various columns and tasks travel from left to right. However the most important for you are three of those columns:
+
Your work in the Test team is mostly up to you. You are free to join any test and you can use any procedure that fits you. However there are some rules that help cooperation with others, prevents fails. You need to get familiar with our Test board where we track all existing testing tasks.
βˆ’
* '''Test on Yubo''', where a list of tasks to be tested on Yubo server is
 
βˆ’
* '''Test on Gingo''', with a list of tasks that supposed to undertake final testing on Gingo server
 
βˆ’
* '''To test on Atys''', where you can find tasks that need to be tested after it was patched on Atys
 
βˆ’
You can comment on each task as you wish. However, please remember that most of the tests have a pad with instructions (see later) and your testing reports should go there not to the board. The link to a corresponding pad is usually attached to the task.
 
  
βˆ’
===Ryzom cloud (Cloud)===
+
'''More information:''' [[The Test Team Handbook/5 - Test board organization|Test board organization]]
βˆ’
As a member of the Testing team, you supposed to see the "Test-Team" folder. It contains various subfolders however for the testing itself you need mostly "1 - DEV_Yubo",  "2 - TEST_Gingo" and "3 - LIVE_Atys". All three folders are similar, one for each testing server and one for the Live server. All contain several other subfolders:
 
  
βˆ’
:#'''Ongoing''' contains pads related to current testing
+
=Step 6: Start testing=
βˆ’
:#'''Minor''' issues contain pads from the previous testing that contain issues to be discussed and solved
+
Now you are getting to the core. Your work would be pointless if you could not provide all details from your testing. There are some tips that can help you in case you have no previous experience with a testing.
βˆ’
:#'''OK''' is a folder for recently finished testing
 
βˆ’
:# '''Archive''' is a place where all documents form testing will end after some time
 
  
βˆ’
Every (testing) pad usually contains instructions about the test itself and is separated into several parts. At the very beginning, you should '''note your name''', client platform and language used during your test. If there is no such section, feel free to create it or remember to mention these details by your report.
+
'''More information:''' [[The Test Team Handbook/6 - Testing report tips|Testing report tips]]
βˆ’
Test instructions are key for you to what is needed to be tested. However you should not stop there and once you have finished all required testing go for additional testing, whatever that you can imagine related to the matter of the tested change. Try to think about the impact of the change on the game, try to find an unexpected way of use, try to break it. Remember, you are still on a testing server, better break it here than on Atys.
 
βˆ’
During or after your testing, use the pad to make notes and reports. More related information you can provide, more helpful it will be. Every detail might be important and, especially in case of final testing on Gingo, the matter of your testing is not the functionality itself but also missing translations, confusing information given by the game, note every non-standard (debug) message or any other glitches. Also, feel free to make your suggestions about any aspect of the change. And '''most important thing''': remember to '''add date and time''' to every new addition you make to the pad.
 
βˆ’
After your tests are done, your work does not end. Please come back later to check if any new changes were done meanwhile and '''review if your questions were answered and issues fixed'''. If not, re-test your issue again (to be sure it remains), note the situation in the pad and feel free to ask directly on the testing channel about it. If the issue was solved, do the test again and confirm in the pad that the issue was fixed and no new appeared.
 
βˆ’
Another important subfolder is TT-Library where you can find some useful documents related to the Testing Team.
 
  
  
Line 116: Line 44:
 
[[Category:Test|Test team]]
 
[[Category:Test|Test team]]
 
[[Category:Tutorials|Test team]]
 
[[Category:Tutorials|Test team]]
βˆ’
Category:Test
+
[[Category:Testing Team]]
βˆ’
Category:Tutorials
+
[[Category:Ryzom Team]]
 +
[[Category:Test]]
 +
[[Category:Tutorials]]

Latest revision as of 11:39, 22 March 2022

de:Das Test-Team-Handbuchβ€’
en:The Test Team Handbookβ€’
es:The Test Team Handbookβ€’
fr:Manuel de l'Γ©quipe de testβ€’
ru:The Test Team Handbookβ€’
 
UnderConstruction.png
Translation to review
Don't blame the contributors, but come and help them 😎

Reference text ( Maintained text, used as reference ) :
Notes: (Ledania, 2022-03-22)

This document gives you quick overview about necessary steps you must undertake to join the Test Team and be able to do good work. It is enriched with links to other documents with more details in case such text exists. If you have any questions or suggestions, feel free ask on #chat-general (accessible for team members only) or #pub-general (open for everybody).

Step 1: Apply to join

If you are willing to apply to become a member of the Testing team, please contact Tamarea, directly on Ryzom chat or by sending an e-mail to tamarea@ryzom.com. You need to get access to team tools and private chat rooms. After this step use the #t-test chat room for any questions related to testing.

More information: Get in touch with Ryzom Forge

Step 2: Get familiar with team tools

As next you need to become familiar with tools used by the Ryzom team. For planning we use Kan Board, for collaboration we have a cloud system and internal (team) chat rooms.

More information: External team tools

Step 3: Configure Ryzom clients

The most of team work and testing is closely tight to our testing servers. You need to create two separated client installations to have access to Yubo, the developers server, Gingo, the testing server and also to beta updates for Atys server.

More information: Setting up connection to non-public Ryzom servers

Step 4: Prepare for testing

Once you have access to testing servers, you need to prepare some characters to perform tests and become familiar with in-game tools for testers. It will make your life much easier.

More information: On a testing server

Step 5: Choose a test

Your work in the Test team is mostly up to you. You are free to join any test and you can use any procedure that fits you. However there are some rules that help cooperation with others, prevents fails. You need to get familiar with our Test board where we track all existing testing tasks.

More information: Test board organization

Step 6: Start testing

Now you are getting to the core. Your work would be pointless if you could not provide all details from your testing. There are some tips that can help you in case you have no previous experience with a testing.

More information: Testing report tips