diff options
| author | Dave Kerr <dwmkerr@gmail.com> | 2019-07-02 19:18:13 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-02 19:18:13 +0800 |
| commit | 2cb6fcda1b159ca3ddcfc47041017efd4aeb914a (patch) | |
| tree | 4bebb0fdde2678178b2479d4841240aa6a6107c2 | |
| parent | b42d50164c87427c9c37791bb0baeec0a14a23b3 (diff) | |
docs: comments on how to localise (#130)
| -rw-r--r-- | .github/contributing.md | 18 | ||||
| -rw-r--r-- | images/gitlocalize.png | bin | 0 -> 109608 bytes |
2 files changed, 17 insertions, 1 deletions
diff --git a/.github/contributing.md b/.github/contributing.md index 6dc01bd..1a5fc6b 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -1,5 +1,13 @@ # Contributing Guidelines + +<!-- vim-markdown-toc GFM --> + +* [Example Law: The Law of Leaky Abstractions](#example-law-the-law-of-leaky-abstractions) +* [Localisation](#localisation) + +<!-- vim-markdown-toc --> + The goal of this project is to have a set of _concise_ definitions to laws, principles, methodologies and patterns which hackers will find useful. They should be: 1. Short - one or two paragraphs. @@ -22,7 +30,7 @@ An example law is shown below, which covers most of the key points: --- -### The Law of Leaky Abstractions +### Example Law: The Law of Leaky Abstractions [The Law of Leaky Abstractions on Joel on Software](https://www.joelonsoftware.com/2002/11/11/the-law-of-leaky-abstractions/) @@ -45,3 +53,11 @@ See also: Real-world examples: - [Photoshop Slow Startup](https://forums.adobe.com/thread/376152) - an issue I encountered in the past. Photoshop would be slow to startup, sometimes taking minutes. It seems the issue was that on startup it reads some information about the current default printer. However, if that printer is actually a network printer, this could take an extremely long time. The _abstraction_ of a network printer being presented to the system similar to a local printer caused an issue for users in poor connectivity situations. + +### Localisation + +We are currently using [GitLocalize](https://gitlocalize.com) to handle translations. This provides features to make it easier for people to manage translations as changes come in: + + + +This is still work in progress - if you would like to be a maintainer for a language just open an issue to get in touch! diff --git a/images/gitlocalize.png b/images/gitlocalize.png Binary files differnew file mode 100644 index 0000000..9d3069f --- /dev/null +++ b/images/gitlocalize.png |
