How to be Tester (For CK3)
Hello! This article will attempt to explain how one can test and review upcoming features, bug fixes, etc.
- Your job is to find pull requests to review, read the changelog, test the changes in-game and write your feedback. Every aspect is explained on this page.
- Review at least one pull request per week!
- If you're active, we will promote you to Senior Tester. The senior keepers get a percent of Patreon donations.
- Try to review PRs with the highest priority.
First, you need to make sure you have the GitHub current version of the mod on your computer. You can learn how you can get it in This Manual. Remember the details on how to switch branches and view pull requests (PRs), it's very important for Keepers to know how to use these functions.
So, you have a GitHub account, the early version, and you're ready for testing! Most likely, someone has already requested your review. If it's not requested, ask developers where they need your review. You can check review requests in Pull requests > Review requests. Also, you can visit this page by Clicking Here.
Images
Here you can see Pull Requests where your review is needed. Clicking on them will open a PR. If you're a new tester, I advise you to look for PRs labeled good first testing. Do it now!
Images
The first comment (see the screenshot below) is the most important part. It explains all the changes and how to quickly test them. Respect your time! If the first comment isn't clear, write a comment on the PR asking for clarifications. Comment writing is available at the bottom of the PR page.
After the changes are clear to you, it's time to switch your current branch to the branch of the PR. The branch name of the PR is mentioned right after the name of the PR itself (see screenshot below).
Images
Let's open Github Desktop and switch to your branch by selecting one on the list.
Images
Do not forget to Fetch and Pull the branch before testing by clicking on the Fetch origin or Pull origin button. If after clicking on the Fetch origin button, you see Pull origin, it means your branch needs updating. Do it by clicking on this Pull origin button. It's extremely important to keep your local branch updated, otherwise, you will be working with outdated content. Do Fetch every time you switch the branch!
The preparations are finished. It's time to start the game and run the early version.
Read information about the Console! If you know how to use the console correctly, it will significantly reduce testing time.
After testing, it's time to write your feedback and mention found bugs.
Let's open the page of the PR we're testing and notice a button called Add review.
Images
It will move you to the page called Files changed. In addition to the Add review button, you can get here by clicking on Files changed on the main page of the PR.
So, what do we see here? First of all, there is the comment section and the 3 types of reviews: Comment, Request changes and Approve. Use Approve comment only if you think everything is balanced and bug-free. Otherwise, leave either Comment (if it's a general feedback) or Request changes (if it's buggy or really unbalanced).
We strongly recommend you to check These Text Tricks. They will make communication with the developers easy and beautiful for clear and concise.
Images
If you're experienced in modding or want to proofread some localization, you can even check the files yourself. They're visible on the Files changed page. By clicking on + and dragging it down (if you want to select more than one line), you can mention the lines of code in your review.
Images
You can even suggest some specific change to the line you selected by clicking on Insert a suggestion. This is especially useful if you want to suggest changing some localization the way you see it.
Images
If your goal is to proofread localization, you can filter files. Being on the Files changed page, click on File filter... and deselect all the file types except .yml. It will hide all the files except localization ones.
Images
That's all! If something isn't clear, Private Message Zumbak on our Discord! Good luck with testing!