git repos / blockattack-game

commit bbf54672

Poul Sander · 2022-01-10 18:07
bbf54672dc7da493438cd76b57fffa7f0201bdd2 patch · browse files
parent 55e336102d3f7ad8c04f831e1d3095fa281911aa

Add CONRIBUTING.md file

Changed files

M CHANGELOG.md before
A CONTRIBUTING.md
M README.md before
diff --git a/CHANGELOG.md b/CHANGELOG.md index 09f4a87..bfbda90 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md
@@ -3,8 +3,11 @@
## Unreleased
+### Added
+ - CONTRIBUTING.md is now included
+
### Changed
- - Now uses libfmt for internal formatting
+ - Now uses {fmt} for internal formatting
## [2.7.0] - 2021-10-23
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ba67138 --- /dev/null +++ b/CONTRIBUTING.md
@@ -0,0 +1,29 @@
+# Contributing
+
+## Introduction
+This is an Open Source project and contributions are welcome.
+
+Both the current graphics and the original sharedir support was provided by kind individuals.
+Patches can be attached to a github ticket or sent to poul@poulsander.com directly. You can also create pull requests on Github.
+
+## Coding
+The project must compile on the olders support LTS version of Ubuntu. It should also be tested on Fedora.
+
+If any dependecies are not provided they must be embedded.
+
+Except for official repositories no internet access should be needed.
+
+Code formatting. The code formatting is handled by astyle. The script `source/misc/astyle/runAstyle.sh`
+
+Windows version is compiled using MXE and docker.
+
+## Translations
+Want to translate to a new language?
+
+This project uses po-files for translations.
+
+The template file can be found in `source/misc/translation/template/blockattack_roftb.pot`. Programs like Poedit (https://poedit.net/) can be used to translate the files.
+
+The resulting po files should be in: `source/misc/translation/po/`
+
+Or just open a ticket and attach the po-file.
diff --git a/README.md b/README.md index cf7caad..fc616b7 100644 --- a/README.md +++ b/README.md
@@ -84,5 +84,4 @@ Please report bugs on github: <https://github.com/blockattack/blockattack-game/i
If possible: Check if the bug is already fixed in master. But if you don't know how to check it then just report it.
## Contributions
-Contributions are welcome. Both the current graphics and the original sharedir support was provided by kind individuals.
-Patches can be attached to a github ticket or sent to poul@poulsander.com directly. You can also create pull requests on Github.
+Contributions are welcome. See CONTRIBUTING.md for details.