diff --git a/.github/contributing.md b/.github/contributing.md index e65eb83..a50d5ac 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -10,7 +10,7 @@ - [How do I know if a law is 'well known' enough?](#how-do-i-know-if-a-law-is-well-known-enough) - [Use of Images](#use-of-images) - [Developer Guide](#developer-guide) -- [Contributor Credit and a Possible Book](#contributor-credit-and-a-possible-book) +- [Contributions and a Possible Book](#contributions-and-a-possible-book) @@ -118,12 +118,14 @@ make serve Run `make` on its own to see the other targets. -## Contributor Credit and a Possible Book +## Contributions and a Possible Book This project may in time be turned into a book. -If that happens, every contributor will be credited in an appendix. Contributors are listed by GitHub handle by default. If you would prefer to be credited by name, please say so in your pull request. +Contributions are treated as proposals and source material for the reference. The maintainer edits and may substantially rewrite accepted material to keep the final text accurate, concise and in a consistent voice. -By opening a pull request you grant the maintainer a permanent, worldwide, royalty-free and non-exclusive licence to use, edit, translate and publish your contribution in any format, including print and electronic editions which are sold. You keep the copyright in what you wrote, and remain free to use it elsewhere yourself. +By opening a pull request you grant the maintainer a permanent, worldwide, royalty-free and non-exclusive licence to reproduce, use, edit, adapt, translate, distribute, sublicense and publish your contribution in any format, including commercial print and electronic editions. + +The maintainer will acknowledge contributions where reasonably practical, but individual attribution cannot be guaranteed for every edited entry, version, format or edition. The repository stays under [CC BY-SA 4.0](../LICENSE) and will remain free to read. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8a8010f..8ddd4b5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,11 +2,11 @@ Please double check the items below! -- [ ] I have read the [Contributor Guidelines](https://github.com/dwmkerr/hacker-laws/blob/master/.github/contributing.md). +- [ ] I have read and agree to the contribution licence in the [Contributor Guidelines](https://github.com/dwmkerr/hacker-laws/blob/main/.github/contributing.md). - [ ] I have not directly copied text from another location (unless explicitly indicated as a quote) or violated copyright. - [ ] I have linked to the original Law. -- [ ] I have quote the law (if possible) and the author's name (if possible). -- [ ] I am happy to have my changes merged, so that I appear as a contributor, but also the text altered if required to keep the language consistent in the project. +- [ ] I have quoted the law (if possible) and the author's name (if possible). +- [ ] I am happy for my contribution to be merged and substantially rewritten to keep the language consistent across the project. And don't forget: diff --git a/README.md b/README.md index 325451d..f57e0b1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -

hacker-laws

+

hacker-laws

๐Ÿง  Laws, Theories, Principles and Patterns for developers and technologists.

--- - ๐Ÿ“– My new book [Effective Shell (Online Version)](https://effective-shell.com) on [Amazon (Print/Kindle)](https://amzn.to/4ho0F91) -- ๐ŸŒ Try [hacker-laws.com](https://hacker-laws.com) +- ๐ŸŒ Try [hackerlaws.dev](https://hackerlaws.dev) - ๐Ÿง  Check out my new project [Terminal AI](https://github.com/dwmkerr/terminal-ai) - โ˜•๏ธ Like this project? Consider [buying me a coffee with a one-off donation](https://github.com/sponsors/dwmkerr?frequency=one-time) - ๐ŸŽง Listen to the podcast [The Changelog - Laws for Hackers to Live By](https://changelog.com/podcast/403) @@ -96,7 +96,7 @@ There are lots of laws which people discuss when talking about development. This repository is a reference and overview of some of the most common ones. Please share and submit PRs! -This project may in time be turned into a book. If it is, all contributors will be credited in an appendix, listed by GitHub handle, or by name if requested in the pull request. See the [Contributing Guidelines](.github/contributing.md) for details. +This project may in time be turned into a book. Contributions will be acknowledged where reasonably practical. See the [Contributing Guidelines](.github/contributing.md) for details. Warning: This repo contains an explanation of some laws, principles and patterns, but does not _advocate_ for any of them. Whether they should be applied will always be a matter of debate, and greatly dependent on what you are working on. @@ -124,12 +124,12 @@ See Also: > The first 90 percent of the code accounts for the first 90 percent of the development time. The remaining 10 percent of the code accounts for the other 90 percent of the development time. -A wry reinterpretation of the [Pareto Principe (or 80-20 rule)](#the-pareto-principle-the-8020-rule) that highlights the real-world challenges of completing engineering work. This sentiment is also echoed in [Hofstadter's Law](#hofstadters-law). +A wry reinterpretation of the [Pareto Principle (or 80-20 rule)](#the-pareto-principle-the-8020-rule) that highlights the real-world challenges of completing engineering work. This sentiment is also echoed in [Hofstadter's Law](#hofstadters-law). See also: - [Hofstadter's Law](#hofstadters-law) -- [The Pareto Principe](#the-pareto-principle-the-8020-rule) +- [The Pareto Principle](#the-pareto-principle-the-8020-rule) ### Amdahl's Law @@ -332,7 +332,7 @@ Real-world examples: See also: - [Goodhartโ€™s Law: How Measuring The Wrong Things Drive Immoral Behaviour](https://coffeeandjunk.com/goodharts-campbells-law/) -- [Dilbert on bug-free software](https://dilbert.com/strip/1995-11-13) +- [Dilbert on bug-free software](https://web.archive.org/web/20220101185323/https://dilbert.com/strip/1995-11-13) ### Hanlon's Razor @@ -701,7 +701,7 @@ 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. +- Photoshop Slow Startup - 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. ### The Law of the Instrument @@ -719,7 +719,7 @@ In the context of computer programming, this law suggests that people tend to us See also: -- [Avoiding the law of the instrument](https://josemdev.com/avoiding-the-law-of-the-instrument/) +- [Avoiding the law of the instrument](https://web.archive.org/web/20210224172007/https://josemdev.com/avoiding-the-law-of-the-instrument/) - [Anti-Pattern - The Golden Hammer](https://archive.org/details/antipatternsrefa0000unse/page/111/mode/2up) ### The Law of Triviality