mirror of
https://github.com/kdeldycke/awesome-falsehood.git
synced 2025-07-31 22:03:11 -04:00
Update and consolidate contribution guidelines.
This commit is contained in:
Kevin Deldycke
parent
169b73296d
commit
54551606b2
2 changed files with 98 additions and 74 deletions
125
CONTRIBUTING.md
125
CONTRIBUTING.md
|
|
@ -1,37 +1,63 @@
|
|||
# Contributing
|
||||
|
||||
Your contributions are always welcome!
|
||||
Your contributions are always welcome! Here are some guidelines.
|
||||
|
||||
|
||||
## Guidelines
|
||||
## Good Candidates
|
||||
|
||||
Before contributing, make sure the new link you'd like to add is a good
|
||||
candidate.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## Pull-Request and Issue
|
||||
|
||||
- Search past and current issues and pull-requests for previous suggestions
|
||||
before making a new one, as yours may be a duplicate or a work in progress.
|
||||
|
||||
- Only one list item per commit.
|
||||
|
||||
- Only one commit per pull-request. Always squash commits after applying
|
||||
changes.
|
||||
|
||||
- List item requirements:
|
||||
|
||||
- Check the new item you want to add to the list is a [good
|
||||
candidate](README.md#good-candidates).
|
||||
- Must follow this template:
|
||||
`- [Link Title](https://example.com) - A short description.`.
|
||||
- Link title must be [title-cased](http://titlecapitalization.com), AP style.
|
||||
- Link title must be stripped out of the "*programmers believe*" part to keep
|
||||
it compact.
|
||||
- URL must use HTTPs protocol if available.
|
||||
- Keep descriptions concise, maximum number of characters is 350.
|
||||
- Description must ends with a period.
|
||||
|
||||
- Add a section if needed.
|
||||
|
||||
- Eventually add a description to the section.
|
||||
- Section title must be linked to from the [table of
|
||||
contents](README.md#contents).
|
||||
- Sections must be alphabetically sorted.
|
||||
|
||||
- Search past and current issues and pull-requests for previous suggestions
|
||||
before making a new one, as yours may be a duplicate or a work in progress.
|
||||
changes.
|
||||
|
||||
- Check your spelling and grammar.
|
||||
|
||||
|
|
@ -39,7 +65,52 @@ before making a new one, as yours may be a duplicate or a work in progress.
|
|||
|
||||
- Use spaces, no tabs, for indention.
|
||||
|
||||
- Send a pull-request with the reason why the linked resource is awesome.
|
||||
|
||||
|
||||
## Linting
|
||||
|
||||
First and foremost, have your pull-request pass the [official Awesome List's
|
||||
linter](https://github.com/sindresorhus/awesome-lint). No extra work is
|
||||
required here as it is [already integrated by the way of GitHub
|
||||
actions](./.github/workflows/).
|
||||
|
||||
To run the linter locally, do:
|
||||
|
||||
```
|
||||
$ npm install --global awesome-lint
|
||||
$ awesome-lint
|
||||
```
|
||||
|
||||
|
||||
## Additional rules
|
||||
|
||||
Here are some formatting style not enforced by the linter (yet), which are
|
||||
specific to this awesome list.
|
||||
|
||||
- Cut long lines of text after 80 characters. Only exception is to let Markdown
|
||||
content be properly rendered.
|
||||
|
||||
- Send a pull-request with the reason why the linked resource is awesome.
|
||||
- If one of these rule conflict with the linter, the linter's rule should takes
|
||||
precedence. Apply it.
|
||||
|
||||
|
||||
## List items
|
||||
|
||||
- Link title must be [title-cased](http://titlecapitalization.com), AP style.
|
||||
|
||||
- Link title must be stripped out of the "*Programmers believe*" part to keep
|
||||
it compact (we all know the scheme).
|
||||
|
||||
- URL must use HTTPs protocol if available.
|
||||
|
||||
- Keep descriptions concise, maximum number of characters is 350.
|
||||
|
||||
|
||||
## Sections
|
||||
|
||||
- Sections must be alphabetically sorted.
|
||||
|
||||
- Add a section if needed.
|
||||
|
||||
- Eventually add a description to the section.
|
||||
|
|
|
|||
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/)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue