summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Kerr <dwmkerr@gmail.com>2021-02-23 17:58:46 +0800
committerDave Kerr <dwmkerr@gmail.com>2021-02-23 17:58:46 +0800
commit96aade10ff9d159b2ac62a7866b3d6164bf62009 (patch)
treed0ecda44ca92f949f76c314e045fa5e07e81f300
parentddfa99d0170ae9dd62bd1402a2d5abdb13d673c0 (diff)
chore: update contributor guidelines
Closes #209.
-rw-r--r--.github/contributing.md17
-rw-r--r--README.md2
2 files changed, 16 insertions, 3 deletions
diff --git a/.github/contributing.md b/.github/contributing.md
index ab0dc60..4acda23 100644
--- a/.github/contributing.md
+++ b/.github/contributing.md
@@ -2,11 +2,16 @@
<!-- vim-markdown-toc GFM -->
+* [Goal of the Project](#goal-of-the-project)
* [Example Law: The Law of Leaky Abstractions](#example-law-the-law-of-leaky-abstractions)
* [Localisation](#localisation)
+* [How do I know if a law is relevant?](#how-do-i-know-if-a-law-is-relevant)
+* [How do I know if a law is 'well known' enough?](#how-do-i-know-if-a-law-is-well-known-enough)
<!-- vim-markdown-toc -->
+## Goal of the Project
+
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.
@@ -30,7 +35,7 @@ An example law is shown below, which covers most of the key points:
---
-### Example Law: 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/)
@@ -54,10 +59,18 @@ 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
+## 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:
![GitLocalize Screenshot](../images/gitlocalize.png)
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!
+
+## How do I know if a law is relevant?
+
+In general, it should be reasonably applicable to the world of computer sciences, IT or coding in general.
+
+## How do I know if a law is 'well known' enough?
+
+A good test is 'If I search for it on Google, will I find it in the first few results?'.
diff --git a/README.md b/README.md
index dd0e0c6..418b07a 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Laws, Theories, Principles and Patterns that developers will find useful.
[Translations](#translations): [🇮🇩](./translations/id.md) [🇧🇷](./translations/pt-BR.md) [🇨🇳](https://github.com/nusr/hacker-laws-zh) [🇩🇪](./translations/de.md) [🇫🇷](./translations/fr.md) [🇬🇷](./translations/el.md) [🇮🇹](https://github.com/csparpa/hacker-laws-it) [🇱🇻](./translations/lv.md) [🇰🇷](https://github.com/codeanddonuts/hacker-laws-kr) [🇷🇺](https://github.com/solarrust/hacker-laws) [🇪🇸](./translations/es-ES.md) [🇹🇷](https://github.com/umutphp/hacker-laws-tr) [🇯🇵](./translations/jp.md) [🇺🇦](./translations/uk.md)
-Like this project? Please considering [sponsoring me](https://github.com/sponsors/dwmkerr) and the [translators](#translations). Also check out this podcast on [The Changelog - Laws for Hackers to Live By](https://changelog.com/podcast/403) to learn more about the project! You can also [download the latest PDF eBook](https://github.com/dwmkerr/hacker-laws/releases/latest/download/hacker-laws.pdf).
+Like this project? Please considering [sponsoring me](https://github.com/sponsors/dwmkerr) and the [translators](#translations). Also check out this podcast on [The Changelog - Laws for Hackers to Live By](https://changelog.com/podcast/403) to learn more about the project! You can also [download the latest PDF eBook](https://github.com/dwmkerr/hacker-laws/releases/latest/download/hacker-laws.pdf). Check the [Contributor Guide](./.github/contributing.md) if you are keen to contribute!
---