Thank you for investing your time in contributing to the project and bring the Fallout Wasteland to Victoria 3!
This guide will be split into two sections:
- Types of contributions
- How to contribute as a Github newcomer
There are many ways to help and contribute to the Dead Money mod. In general, contributions will fall into one of the following categories:
Until a Discord server is set up, anyone is welcome to use the discussions pages to talk about the mod, suggest ideas, or get in general contact with people working on the mod.
If you encountered a bug in the mod, create a new issue using the relevant template.
To post suggestions on what the mod should or could add, create a new issue using the relevant template or mention it in the discussions.
Note
Just be aware, that "person that wants others to work on implementing their ideas" are a dime a dozen. The best way to see an idea implemented is to work on it yourself.
Testing early builds and giving feedback can always be used. For general feedback see the discussions pages, and for balancing or bug feedback create a new issue using the relevant template.
This mod is written in English. However, plenty of people might prefer to play Victoria 3 and Dead Money using their native tongue. People that want to take on the task to translate the mod are welcomed to do so and help out. Ongoing translation efforts are labelled with the translation label.
Progress on the mod is done through the creation and solving of issues.
Issues can be anything from extremely specific things, like Add Robots Good to evergreen, overarching umbrella issues that always require work and are never closed, like the adding of Country Flags. Issues can be the concept of Adding More Events, to individual issues representing a specific event someone is working on.
Solving or creating issues the most straightforward way to contribute to the mod.
If you spot or encounter a problem, search if a similar issue already exists. Alternatively you can open a new issue using a relevant issue form, or if addressing something specific open a blank issue.
Scan through the issues labelled as needing help to find one that interests you and you could help out with, or in general look through all issues and offer help.
Here are some resources to help you get started with open source contributions:
Issues are used to track tasks that contributors can help with.
If you spot or encounter a problem, search if a similar issue already exists. Alternatively, you can open a new issue using a relevant issue form.
- Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
- Create a working branch and start with your changes!
Commit the changes once you are happy with them.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
Optionally:
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉
Your contribution is gonna get added to the list of credits.
Most likely the mod owners have been in contact with you over the course of this, and if you wanna continue to help out with the mod, you're welcome to stay.