How to be Tinker (Developer)
If you're a new developer, read step by step to the Guidelines section. We explain how to set the mod and how we work on GitHub. The Guidelines have information about working in different fields of the mod and can be read along the way (during working).
- Be active in the dev chats so we can give feedback and help you!
- Pick Tasks so we're always busy and progressing!
- Create Tasks for yourself and others. If you have a vision of the mod, it's very welcome!
First, to understand how GitHub works, I would recommend reading This.
GitHub Desktop is the easiest program to do it. It has a nice user-friendly interface but lacks some pro-features like conflicting resolving. The desktop is a good choice if you add/fix texts or do small changes. Just don't forget to click Pull origin and Push origin when you can. How to install it and download the mod is explained Here (if you have already done it, ignore).
Read These Basics to understand how to open and switch branches, commit. If you work on localization only this will be enough.
If you're familiar with another git client, we don't mind if you use yours instead.
We sort all our tasks as the Issues. You can use labels to find and sort tasks in your fields. Here you can read the Label List.
Images
If you're a developer, you're free to open new issues you want to do in the future. It's a very useful tool!
Images
If something isn't clear or you want to speak about the issue, you can use the comment section on each issue.
Images
Finally, once you feel you want to work on this issue, assign yourself by clicking the Assigners and finding you in the list.
Images
We separate features from each other on things called Branches. So once you take some task, you can open a new branch for it or switch to an existing one.
Once you feel like your branch is done, find it in the Branch List, open a Pull Request, write the changelog (it should be short and detailed enough), request reviews from the CK3 Testers, assign yourself and relevant labels, and create the PR.
Images
Ping CK2 Tester in the ck2-testing channel of our Discord to notify the testers we have a new PR to test.
Read These Basics to understand how to open and switch branches, commit. If you work on localization only this will be enough.
If you work on new features or want to know more, you better read This. It explains how to work with different repositories, open pull requests and more.
Before starting any work, I would recommend you reading These Rules and These Guidelines, they can help you avoid problems and give important information about different aspects.
If you're a developer who works on big features, you better know all GitHub's tools. I would recommend reading these guides: