Skip to content
Snippets Groups Projects
Select Git revision
  • BlackAion-development-patch-54478
  • master
  • development default protected
  • feature/arousal
  • feature/virginity_system
  • fix/grammar_had_sex_with_effect
  • 1.6.3
  • 1.6.2
  • 1.6.1
  • 1.6
  • 1.5.2
  • 1.5.1
  • 1.5
  • 1.4.2
  • 1.4.1
  • 1.4
  • 1.3.6
  • 1.3.5
  • 1.3.4
  • 1.3.3
  • 1.3.2
  • 1.3.1
  • 1.3
  • 1.2,4
  • 1.2.3
  • 1.2.2
26 results
Blame Permalink
Forked from Cheri / Carnalitas
606 commits behind the upstream repository.
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 2.53 KiB

How to contribute to the Carnalitas Framework

You want to add a new feature or bugfix

In order to keep the development branch stable, you should not commit directly to it. Here is the workflow you should follow:

Create a new branch

If you are an official contributor to this project, create a new branch from the "developing" branch (you can do it from github or directly from your local git repository)

If you are not an official contributor, you can fork this project and work on your feature there

  • It is recommended to name your branch "feature/concise-name-of-the-feature" for a new feature or "fix/concise-name-of-the-bugfix" for a bugfix.

Work on your branch

You can now start working on your feature by pushing your modification to your feature branch.

  • Only add changes that are related to that feature

Create a pull request

Once your feature is done, or at least stable and functioning (doesn't cause crashes or break existing stuff), you can create a pull request from your feature branch to the development branch

  • Follow the template instructions
  • Add a reviewer to the pull request (cherisong and potentially another contributor who already worked on the code you are modifying)
  • Add the label "enhancement" and any other relevant label, like "visual" if you made some graphical modification
  • If your feature or bugfix is supposed to close or fix an existing issue, please link it in the pull request (the option is also in the right-hand column)

Adding new translations

Translations go into the localization folder where each language gets its own sub directory. You can use the localization helper to quickly setup a new language (requires Python):

In a terminal (shell, cmd, powershell...), execute the following command

python localization_helper.py update --lang <language>

Where <language> is the name of the language you want to translate to, eg: german.

Before running the script, make sure that all the strings already translated are in the format key:1 "value". The :1 tells the script that this line is already translated and thus should not be changed. The script will then add all the missing strings, in english, and with the format key:0 "value".

Important: Once you have translated a string, do not forget to replace the :0 by a :1. Every string with a different format than key:1 "value" will be replaced by the english value when you run the script

If you want to see translation statistics use python localization_helper.py stats.