openwall / openwall/john

We lack developer documentation

Open
#1,475 16 comments 0 reactions 1 assignee View on GitHub

@frank-dittrich is already working on this.

Since Mar 18, 2016.

documentation maintenance/cleanup
Dominant language
C
Stars
13.6k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

What we need to document:

  • How to implement a new format.
  • Which format to pick for a template
  • How to advance from a simple implementation to one with SIMD support
  • When and how to implement thin formats

(And I am sure lots of other stuff)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.