Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

25 lines (15 loc) · 2.97 KB

Phases

0. Purpose and Aim of the Book as published here since May 11, 2020, has an annotated table of contents, folders for chapters and collects references and core topics in each chapter; join TE Discord Channel #te-book for discussions and updates

1. Early Access starting from 20 June 2020; show your support, help fund bounties for code examples, illustrations, interviews; get access to early drafts as they are being written, raw-cuts of interviews, scribbles; comment and ask questions, decide on which chapters should be worked on first, get your NFT and direct its revenue share from edited book sales to your favorite OSS projects in the TE community. You can also adapt and commercially use the edited version (see licence). Early access ends 1-2 weeks before next phase. All co-/authors support through Early Access.

2. Presale starts in September 2020 and mainly funds editing for print and marketing efforts, presale comes at a discount, and preale participants will receive excerpts until December 2020, when the book is ready to ship.

Contributing here

You can start right away and across all phases and thereafter:

  • For a quick fix: Clicking on "edit" when viewing a specific file, GitHub's UI will automatically fork and let you create a pull request
  • More involved: fork --> clone locally --> make new branch naming it according to your add-on perspective --> make your changes --> push it back to your repo --> click the "compare & pull request"

If this is your first time contributing don't hesitate to also drop by the TE Discord channel of #te-book.

When a Chapter is deemed ready to exit Early Access, it gets an update in this public repository. Many chapters will benefit from an early exit, e.g. ones with examples, or references, which can be extended and improved upon in this repo. Substantial valuable input for a Chapter that goes into print editions can get you added as co-author, or acknowledged otherwise, e.g. in form of discounts on hard copies of the book. In any case contributors here earn TE Creds.

Join the Early Access phase to put some skin in the game!

Style

You get extra credits for making the content more fun, engaging, and visual.

References in a Chapter go to it's References.md in APA Format

Most of the sample code is in Phyton in notebooks. Depending on how Jupyter{Book} evolves we might use it sometime from Early Access to Presale. As for code in any other language, e.g. Solidity, use original style-guide.