summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2025-07-27 21:38:30 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2025-07-27 21:38:30 +0200
commit7b1847c61bfb53391928cf6184bfec4802a0f10b (patch)
tree70b3526d0114eefdb1790418da0ac215b9718eac
parent9f37f016c66078bbcc57fc09685e51e4062805ab (diff)
Add contribution notes
-rw-r--r--README.md1
-rw-r--r--doc/contributing.md31
2 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
index 48ecb18..aaf37b0 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ for EFA instances and bahn.de is under way.
You can use the public instance on [travelynx.de](https://travelynx.de) or
host your own. Further reading:
+* [Contributing](doc/contributing.md) to travelynx development
* [Setup](doc/setup.md) for hosting your own instance
* [Usage](doc/usage.md) primer (what is this whole “checking in” about?)
diff --git a/doc/contributing.md b/doc/contributing.md
new file mode 100644
index 0000000..95e61b2
--- /dev/null
+++ b/doc/contributing.md
@@ -0,0 +1,31 @@
+# Contributing to travelynx Development
+
+First, a note upfront: travelynx is a hobby project.
+While I appreciate suggestions, bug reports, and merge requests / patches, I want to make sure that it remains a hobby project and does not turn into a chore.
+As such, please do not expect a timely response to anything you submit.
+I typically only address issues and merge requests when I have the capacity for them _and_ when doing so does not feel like a chore.
+
+That being said, I do appreciate bug reports, feature requests, and (simple!) patches, even if I make take quite a while to address or review them.
+If you are planning a more involved patch set, please get in touch first.
+
+## Translations
+
+This is probably the easiest way to improve the life of any travelynx users who are not native German speakers.
+
+### Updating or Extending Translations
+
+* Look at the [translation reference](/share/locales/reference.md)
+* Pick a language that you'd like to fix / update / extend
+* Adjust the corresponding `share/locales/ab-CD.po` file
+* Open a merge request, either on [Codeberg](https://codeberg.org/derf/travelynx/pulls) or [GitHub](https://github.com/derf/travelynx/pulls)
+
+### Adding a new Language
+
+* Copy `share/locales/template.pot` to `share/locales/ab-CD.po`, replacing ab-CD with the appropriate language code
+* Add the language / locale to `$self->helper(loc_handle …` in `lib/Travelynx.pm` and `templates/language.html.ep`
+* Provide as many translations as you feel comfortable with – partial translation files are fine; any entry left as `msgstr ""` will cause travelynx to fall back to English or German.
+* Open a merge request, either on [Codeberg](https://codeberg.org/derf/travelynx/pulls) or [GitHub](https://github.com/derf/travelynx/pulls)
+
+## Bug Reports
+
+You may report bugs and request features either on [Codeberg](https://codeberg.org/derf/travelynx/issues) or [GitHub](https://github.com/derf/travelynx/issues).