Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 6.22 KB

CONTRIBUTING.md

File metadata and controls

85 lines (53 loc) · 6.22 KB
Raw

Welcome to Dead Money contributing guide

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:

  1. Types of contributions
  2. How to contribute as a Github newcomer

1. Types of Contributions

This is very much a pet project of mine ( Araxiel), as such I don't really expect anyone anytime soon to contribute. However, who knows over long enough of a timescale things might change.

🐛 Bugs

If you encountered a bug in the mod, create a new issue using the relevant bug report issue template.

📮 Suggestions

To post suggestions on what the mod should or could add, create a new issue using the relevant template or mention it to me.

Note

Just be aware that this is very much a pet project of mine, so none of these suggestions are binding.

🔬 Testing

Testing early builds and giving feedback can always be used. And I also just like hearing from people. For more specific balancing or bug feedback, create a new issue using the relevant template.

🌏 Translations

This mod is written in English. However, plenty of people might prefer to play Victoria 3 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.

🚩 Issues

Progress on the mod is done through the creation and solving of issues.

Solving or creating issues the most straightforward way to contribute to the mod.

Create a new issue

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.

Solve an existing 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.

2. GitHub newcomer

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.

Make changes locally

  1. Fork the repository.
  1. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them.

Pull Request

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.

Your PR is merged!

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.