Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (46 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

70 lines (46 loc) · 2.74 KB
Raw

Table of Contents

Contributing

Thanks for your interest in improving this list! Contributions are welcome via pull request.

Submitting an article

Please only submit articles that add value to this repository. In particular, articles should be "classics", i.e., articles that have withstood or will withstand the test of time because they have valuable things to say. The list is intentionally concise and opinionated (see Principles), so not every suggestion will be added.

Please do NOT submit articles or resources that fall into one or more of these categories:

  • Paid-for material. I will consider those in extremely rare cases, and certainly NOT when you are the author.
  • Overly narrow topic for an article or a tool. For instance, I do list certain resources specific to a programming language or database, but only because they teach invaluable things.
  • Self-promotion. Do not submit articles from your own blog unless you think they qualify as a potential "classic". If you do submit from your own blog, please state it in the PR message. Failing to do so will result in an immediate rejection.

If your submission falls into two or more of those categories, it will most probably be rejected.

Articles must be in English and freely readable. Hard paywalls count as paid-for material.

Formatting

Add the article at the end of the most relevant topic section in README.md, following the format of the surrounding entries:

- [Title](https://example.com/article), Author Name: optional one-line summary.
  • Use the emoji legend for non-article resources (📖 book, 🎞 video, 🧰 list, etc.).
  • Prefer the canonical, stable URL over tracking links or mirrors.
  • Don't edit the table of contents by hand: it's generated by doctoc via the pre-commit hooks.

Writing the PR

The PR title and commit message should follow the existing format:

[Verb in imperative] something something

For example:

Add article about toasters

Pre-commit hooks

This repo uses prek, a faster drop-in alternative to pre-commit. Hooks are defined in .pre-commit-config.yaml.

# install the git hooks
$ prek install

# do a simple run
$ prek run

# update the hooks
$ prek autoupdate