Skip to content

Latest commit

聽

History

History
180 lines (125 loc) 路 4.58 KB

CONTRIBUTING.md

File metadata and controls

180 lines (125 loc) 路 4.58 KB
Raw

Contributing

Table of Contents

General Guides

Take a look at our wishlist 馃榾.

Adding an Item

Please ensure your item adheres to the following format:

- [Item Title](item link)
  - **Author(s)**: [*Author Name*](author link)
  - **Tags**: *tag1*, *tag2*, ..., *tagN*
  - **Language**: Item Language <Item Language Flag Emoji>

Where:

  • Item Title:
    • isRequired: true
    • type: String
  • item link:
    • isRequired: true
    • type: String
  • Author Name:
    • isRequired: true
    • type: String
  • author link:
    • isRequired: false
    • type: String
  • Tags:
    • isRequired: true
    • type: Array<String>
  • Item Language:
    • isRequired: true (if other than English)
    • type: String
  • Item Language Flag Emoji:
    • isRequired: false
    • type: String<Emoji>

E.g.

- [The Genuine Sieve of Eratosthenes](https://www.cs.hmc.edu/~oneill/papers/Sieve-JFP.pdf)
  - **Author(s)**: [*Melissa E. O鈥橬eill*](https://www.cs.hmc.edu/~oneill/)
  - **Tags**: *functional programming*, *haskell*, *lazy*, *Sieve of Eratosthenes*
  - **Language**: *English* 馃嚞馃嚙

Which renders to:

Please make sure your additions follow alphabetical order.

Adding a Section

Please ensure your section adheres to the following format:

## Section Title

Where:

  • Section Title:
    • isRequired: true
    • type: String

E.g.

## Algorithms

In order to uptade the Table of Contents then run:

Make sure you have both Node.js and npm.

npm install
npm start

Please make sure your additions follow alphabetical order.

Git Commit Guidelines

Describes how Git commits are annotated.

The reasons for these conventions

  • automatic generating of the changelog;
  • simple navigation through git history (eg. ignoring style changes)

Format of the commit message

<type>(<scope>):

<body>

<footer>

It should not be longer than 80 characters, second line is always blank and other lines should be wrapped at 80 characters.

Allowed type values

<type> meaning
item a new post, paper, book etc. is introduced for an existing category
category a new category/subcategory is introduced
fix indicates changes that fix outstanding problems, misconceptions etc.
style indicates a commit that only changes style guide of this document
docs indicates commits that change commentary, document`tion etc.
chore updating project organization, automation etc.

Example scope values

  • main list
  • global
  • header
  • license
  • contributing guidelines
  • etc.

The <scope> can be empty (eg. if the change is a global or difficult to assign to a single component), in which case the parentheses are omitted.

Body

  • Uses the imperative, present tense; e.g. change鈥搉ot changed nor changes;
  • Includes motivation for the change and contrasts with previous content.

Footer

Referencing Issues

Closed issues should be listed on a separate line in the footer prefixed with Closes keyword like this:

Closes #234

Or, in case of multiple issues:

Closes #123, #245, #992

Wrapping It All Together

An example commit would be:

item (Math): add "The Genuine Sieve of Eratosthenes" paper

Or:

category (root): add "Programming Languages Theory" category