Update and consolidate contribution guidelines.
This commit is contained in:
47
README.md
47
README.md
@@ -30,10 +30,6 @@ A curated list of awesome falsehoods programmers believe in.
|
||||
- [Software Engineering](#software-engineering)
|
||||
- [Typography](#typography)
|
||||
- [Contributing](#contributing)
|
||||
- [Good Candidates](#good-candidates)
|
||||
- [Falsehood Articles](#falsehood-articles)
|
||||
- [Libraries](#libraries)
|
||||
- [Data Structures](#data-structures)
|
||||
- [License](#license)
|
||||
|
||||
|
||||
@@ -331,49 +327,6 @@ Your contributions are always welcome! Please take a look at the
|
||||
[contribution guidelines](CONTRIBUTING.md) first.
|
||||
|
||||
|
||||
## Good Candidates
|
||||
|
||||
Here is a non-restrictive list of items which are good candidates for inclusion
|
||||
in this awesome list.
|
||||
|
||||
|
||||
### Falsehood Articles
|
||||
|
||||
Articles following the *falsehood* scheme are prime candidates for inclusion in
|
||||
this awesome list.
|
||||
|
||||
These articles starts with the hypothesis that developers have a naive, simple
|
||||
view of the subject at hand. Then proceed to list a set of candid assumptions
|
||||
that might be held by such programmers. Each one is intentionally false, and
|
||||
sometimes illustrated by a counter-example.
|
||||
|
||||
A list of falsehood is crafted as a progression that is designed to refine
|
||||
concepts. Having read the whole list of falsehood, the reader should possess a
|
||||
global, if not complete, overview of the domain being targeted by the article,
|
||||
including most, if not all, its pitfalls, edges-cases and inconsistencies.
|
||||
|
||||
In the worst case, these articles might provoke an emotional reaction and cause
|
||||
flipping table. `(╯°□°)╯︵ ┻━┻`
|
||||
|
||||
Articles featuring items that are applicable to a product and a product only
|
||||
can't really be considered as generic falsehood articles and should be avoided.
|
||||
|
||||
|
||||
### Libraries
|
||||
|
||||
When possible, we provide a list of programming libraries or modules that may
|
||||
solve, or try to, the complexities and idiosyncrasies pointed by the
|
||||
*falsehood* articles above.
|
||||
|
||||
So we can put back tables in place. `┬─┬ ノ( ゜-゜ノ)`
|
||||
|
||||
|
||||
### Data Structures
|
||||
|
||||
Data models and structures generic enough to cover and address most of the
|
||||
falsehoods are also welcome in this page.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
[](https://creativecommons.org/publicdomain/zero/1.0/)
|
||||
|
||||
Reference in New Issue
Block a user