First draft of new docset on Contributing to BigchainDB

docs/contributing/Makefile

@@ -0,0 +1,225 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -W
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  epub3      to make an epub3"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+	@echo "  dummy      to check syntax errors of document sources"
+
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/BigchainDB.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/BigchainDB.qhc"
+
+.PHONY: applehelp
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+.PHONY: devhelp
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/BigchainDB"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/BigchainDB"
+	@echo "# devhelp"
+
+.PHONY: epub
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+	$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+	@echo
+	@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+	@echo
+	@echo "Build finished. Dummy builder generates no files."

docs/contributing/requirements.txt

@@ -0,0 +1,4 @@
+Sphinx>=1.4.8
+recommonmark>=0.4.0
+sphinx-rtd-theme>=0.1.9
+wget

docs/contributing/source/conf.py

@@ -0,0 +1,367 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# BigchainDB documentation build configuration file, created by
+# sphinx-quickstart on Thu Sep 29 11:13:27 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import wget # is for real!
+
+from os import rename
+from recommonmark.parser import CommonMarkParser
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+import sphinx_rtd_theme
+
+extensions = [
+    'sphinx.ext.autosectionlabel',
+]
+
+# Get remote files to here.
+# Because this is just Pyton and we can do whatever Python can do:
+
+url1 = 'https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/CODE_OF_CONDUCT.md'
+filename1 = wget.download(url1)
+rename('CODE_OF_CONDUCT.md', 'cross-project-policies/code-of-conduct.md')
+
+url2 = 'https://raw.githubusercontent.com/vrde/bigchaindb-org/16b503b7c34e64f96aaccaefc4c826492174a5ae/protocols/shared-workspace.md'
+filename2 = wget.download(url2)
+rename('shared-workspace.md', 'cross-project-policies/shared-workspace.md')
+
+url3 = 'https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/RELEASE_PROCESS.md'
+filename3 = wget.download(url3)
+rename('RELEASE_PROCESS.md', 'cross-project-policies/release-process.md')
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ['.rst', '.md']
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Contributing to BigchainDB'
+copyright = '2017, BigchainDB Contributors'
+author = 'BigchainDB Contributors'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'BigchainDB v0.1'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'BigchainDBdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+     # The paper size ('letterpaper' or 'a4paper').
+     #
+     # 'papersize': 'letterpaper',
+
+     # The font size ('10pt', '11pt' or '12pt').
+     #
+     # 'pointsize': '10pt',
+
+     # Additional stuff for the LaTeX preamble.
+     #
+     # 'preamble': '',
+
+     # Latex figure (float) alignment
+     #
+     # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'BigchainDB.tex', 'Contributing to BigchainDB',
+     'BigchainDB Contributors', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# It false, will not define \strong, \code, 	itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'bigchaindb', 'Contributing to BigchainDB',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'BigchainDB', 'Contributing to BigchainDB',
+     author, 'BigchainDB', 'How to contribute to BigchainDB.',
+     'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False

docs/contributing/source/cross-project-policies/code-of-conduct.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute to the project.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, nationality, or species--no picking on Wrigley for being a buffalo!
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Deliberate intimidation
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior directed at yourself or another community member may be
+reported by contacting a project maintainer at [conduct@bigchaindb.com](mailto:conduct@bigchaindb.com). All
+complaints will be reviewed and investigated and will result in a response that
+is appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

docs/contributing/source/cross-project-policies/index.rst

@@ -0,0 +1,12 @@
+Policies
+========
+
+
+.. toctree::
+   :maxdepth: 1
+
+   code-of-conduct
+   shared-workspace
+   release-process
+   release-process-note
+   

docs/contributing/source/cross-project-policies/release-process-note.md

@@ -0,0 +1,4 @@
+# A Note on Our Release Process
+
+Our Release Process hasn't been revised for C4 yet. It should be. That will simplify it a lot. Releases are just tags on the ``master`` branch. There are no
+topic branches!

docs/contributing/source/cross-project-policies/release-process.md

@@ -0,0 +1,73 @@
+# Our Release Process
+
+The release process for BigchainDB server differs slightly depending on whether it's a minor or a patch release.
+
+BigchainDB follows 
+[the Python form of Semantic Versioning](https://packaging.python.org/tutorials/distributing-packages/#choosing-a-versioning-scheme)
+(i.e. MAJOR.MINOR.PATCH),
+which is almost identical
+to [regular semantic versioning](http://semver.org/)
+except release candidates are labelled like
+`3.4.5rc2` not `3.4.5-rc2` (with no hyphen).
+
+
+## Minor release
+
+A minor release is preceeded by a feature freeze and created from the 'master' branch. This is a summary of the steps we go through to release a new minor version of BigchainDB Server.
+
+1. Update the `CHANGELOG.md` file in master
+1. In `k8s/bigchaindb/bigchaindb-dep.yaml` AND in `k8s/dev-setup/bigchaindb.yaml`, find the line of the form `image: bigchaindb/bigchaindb:0.8.1` and change the version number to the new version number, e.g. `0.9.0`. (This is the Docker image that Kubernetes should pull from Docker Hub.) Commit that change to master
+1. Create and checkout a new branch for the minor release, named after the minor version, without a preceeding 'v', e.g. `git checkout -b 0.9` (*not* 0.9.0, this new branch will be for e.g. 0.9.0, 0.9.1, 0.9.2, etc. each of which will be identified by a tagged commit)
+1. Push the new branch to GitHub, e.g. `git push origin 0.9`
+1. Create and checkout a new branch off of the 0.9 branch. Let's call it branch T for now
+1. In `bigchaindb/version.py`, update `__version__` and `__short_version__`, e.g. to `0.9` and `0.9.0` (with no `.dev` on the end)
+1. Commit those changes, push the new branch T to GitHub, and use the pushed branch T to create a new pull request merging the T branch into the 0.9 branch.
+1. Wait for all the tests to pass! Then merge T into 0.9.
+1. Follow steps outlined in [Common Steps](#common-steps)
+1. In 'master' branch, Edit `bigchaindb/version.py`, increment the minor version to the next planned release, e.g. `0.10.0.dev`. (Exception: If you just released `X.Y.Zrc1` then increment the minor version to `X.Y.Zrc2`.) This step is so people reading the latest docs will know that they're for the latest (master branch) version of BigchainDB Server, not the docs at the time of the most recent release (which are also available).
+1. Go to [Docker Hub](https://hub.docker.com/), sign in, go to bigchaindb/bigchaindb, go to Settings - Build Settings, and under the build with Docker Tag Name equal to `latest`, change the Name to the number of the new release, e.g. `0.9`
+
+Congratulations, you have released BigchainDB!
+
+## Patch release
+
+A patch release is similar to a minor release, but piggybacks on an existing minor release branch:
+
+1. Check out the minor release branch, e.g. `0.9`
+1. Apply the changes you want, e.g. using `git cherry-pick`.
+1. Update the `CHANGELOG.md` file
+1. Increment the patch version in `bigchaindb/version.py`, e.g. `0.9.1`
+1. Commit that change
+1. In `k8s/bigchaindb/bigchaindb-dep.yaml` AND in `k8s/dev-setup/bigchaindb.yaml`, find the line of the form `image: bigchaindb/bigchaindb:0.9.0` and change the version number to the new version number, e.g. `0.9.1`. (This is the Docker image that Kubernetes should pull from Docker Hub.)
+1. Commit that change
+1. Push the updated minor release branch to GitHub
+1. Follow steps outlined in [Common Steps](#common-steps)
+1. Cherry-pick the `CHANGELOG.md` update commit (made above) to the `master` branch
+
+## Common steps
+
+These steps are common between minor and patch releases:
+
+1. Go to the [bigchaindb/bigchaindb Releases page on GitHub](https://github.com/bigchaindb/bigchaindb/releases)
+   and click the "Draft a new release" button
+1. Fill in the details:
+   - Tag version: version number preceeded by 'v', e.g. "v0.9.1"
+   - Target: the release branch that was just pushed
+   - Title: Same as tag name above, e.g "v0.9.1"
+   - Description: The body of the changelog entry (Added, Changed, etc.)
+1. Click "Publish release" to publish the release on GitHub
+1. Make sure your local Git is in the same state as the release: e.g. `git fetch <remote-name>` and `git checkout v0.9.1`
+1. Make sure you have a `~/.pypirc` file containing credentials for PyPI
+1. Do a `make release` to build and publish the new `bigchaindb` package on PyPI
+1. [Login to readthedocs.org](https://readthedocs.org/accounts/login/) and go to the **BigchainDB Server** project (*not* **BigchainDB**), then:
+   - Go to Admin --> Advanced Settings
+     and make sure that "Default branch:" (i.e. what "latest" points to)
+     is set to the new release's tag, e.g. `v0.9.1`.
+     (Don't miss the 'v' in front.)
+   - Go to Admin --> Versions
+     and under **Choose Active Versions**, do these things:
+     1. Make sure that the new version's tag is "Active" and "Public"
+     2. Make sure the new version's branch
+        (without the 'v' in front) is _not_ active.
+     3. Make sure the **stable** branch is _not_ active.
+     4. Scroll to the bottom of the page and click the Submit button.

docs/contributing/source/cross-project-policies/shared-workspace.md

@@ -0,0 +1,28 @@
+# Shared Workspace Protocol
+![raw](http://rfc.unprotocols.org/spec:2/COSS/raw.svg)
+
+- Name: Shared Workspace Protocol
+- Status: raw
+- Editor: Alberto Granzotto <alberto@bigchaindb.com>
+
+## Abstract
+Focusing in a shared workspace (or in the office in general) can be a really challenging task. Working from home solves the problem, but it is not an ideal solution if forced by the difficulty to focus in the office.
+
+The "Shared Workspace Protocol" ("SWP" henceforth) provides a simple set of rules for people working in the same workspace.
+
+## Language
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) \[[RFC2119](https://tools.ietf.org/html/rfc2119)\] \[[RFC8174](https://tools.ietf.org/html/rfc8174)\] when, and only when, they appear in all capitals, as shown here.
+
+## Goals
+SWP provides a reusable collaboration model for people working in the same workspace. It has these specific goals:
+
+1. To maximize focus and productivity, by reducing the sources of distraction.
+1. To reduce the burden to ask people to "behave" or "leave the room", by having an explicit protocol people agree before entering the room.
+
+## Design
+1. When implemented, this protocol MUST be visible at the entrance of the shared workspace.
+1. A person SHOULD write a message to another person before speaking with them.
+1. A person SHOULD NOT be loud.
+1. A person SHOULD NOT talk to more than one person at a time.
+1. One-on-one conversations MUST be short and occasional.
+1. A person MUST NOT have calls unless everyone in the room is involved.

docs/contributing/source/index.rst

@@ -0,0 +1,22 @@
+Contributing to BigchainDB
+==========================
+
+There are many ways you can contribute to BigchainDB.
+It includes several sub-projects.
+
+- `BigchainDB Server <https://github.com/bigchaindb/bigchaindb>`_
+- `BigchainDB Python Driver <https://github.com/bigchaindb/bigchaindb-driver>`_
+- `BigchainDB JavaScript Driver <https://github.com/bigchaindb/js-bigchaindb-driver>`_
+- `cryptoconditions <https://github.com/bigchaindb/cryptoconditions>`_ (a Python package by us)
+- `py-abci <https://github.com/davebryson/py-abci>`_ (a Python package we use)
+- `BigchainDB Enhancement Proposals (BEPs) <https://github.com/bigchaindb/BEPs>`_
+
+
+Ways You Might Contribute
+-------------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   cross-project-policies/index
+   ways-can-contribute/index

docs/contributing/source/ways-can-contribute/answer-questions.md

@@ -0,0 +1,11 @@
+# Answer Questions
+
+People ask questions about BigchainDB in the following places:
+
+- Gitter
+  - [bigchaindb/bigchaindb](https://gitter.im/bigchaindb/bigchaindb)
+  - [bigchaindb/js-bigchaindb-driver](https://gitter.im/bigchaindb/js-bigchaindb-driver)
+- [Twitter](https://twitter.com/bigchaindb)
+- [Stack Overflow "bigchaindb"](https://stackoverflow.com/search?q=bigchaindb)
+
+Feel free to hang out and answer some questions. People will be thankful.

docs/contributing/source/ways-can-contribute/bug-report.md

@@ -0,0 +1,26 @@
+# Write a Bug Report
+
+1. Go to the repository with the source code for the bug. Possibilities include:
+
+   - [BigchainDB Server](https://github.com/bigchaindb/bigchaindb)
+   - [BigchainDB Python Driver](https://github.com/bigchaindb/bigchaindb-driver)
+   - [BigchainDB JavaScript Driver](https://github.com/bigchaindb/js-bigchaindb-driver)
+   - [cryptoconditions](https://github.com/bigchaindb/cryptoconditions) (a Python package by us)
+   - [py-abci](https://github.com/davebryson/py-abci) (a Python package we use)
+
+1. Click on the **Issues** tab.
+1. Click the button to create a **New Issue**.
+1. Describe everything in detail:
+
+   - What computer are you on (hardware)
+   - What operating system are you using, including version. e.g. Ubuntu 14.04? Fedora 23? If it's not a Linux distro, then that's probably the problem.
+   - What version of BigchainDB software were you using? Did you update it to the latest?
+   - What, exactly, did you do to get to the point where you got stuck? Describe all the steps so we can get there too.
+   - Show screenshots or copy-and-paste text to GitHub
+   - Say what you expected to happen
+   - Show what actually happened
+   - Say what you tried to do to resolve the problem
+   - Provide details to convince us that it matters to you. Is it for a school project, a job, a contract with a deadline, a child who needs it for Christmas?
+
+We will do our best but please understand that we don't have time to help everyone, especially people who don't care to help us help them. "It doesn't work." is not going to get any reaction from us. We need _details_.
+

docs/contributing/source/ways-can-contribute/index.rst

@@ -0,0 +1,11 @@
+Ways to Contribute
+==================
+
+.. toctree::
+   :maxdepth: 1
+
+   bug-report
+   write-a-bep
+   write-code
+   write-docs
+   answer-questions

docs/contributing/source/ways-can-contribute/write-a-bep.md

@@ -0,0 +1,9 @@
+# Write a BigchaindB Enhancement Proposal (BEP)
+
+This is what you do if you want to request a new feature or a change in how BigchainDB works. The more clearly you write,
+the better chance you have of convincing us that it's easy and worth doing.
+
+1. Review [2/COSS](https://github.com/bigchaindb/BEPs/tree/master/2). Maybe print it for reference.
+1. Folowing those guidelines, make a pull request against the [bigchaindb/BEPs](https://github.com/bigchaindb/BEPs) repository on GitHub.
+1. Don't spend weeks on this. Version 1 should take a few hours to write up, maximum. You can add to it in the future. The process is iterative.
+   If you need more than a few hours, then consider writing multiple BEPs, because your idea is too big to fit into one BEP.

docs/contributing/source/ways-can-contribute/write-code.rst

@@ -0,0 +1,125 @@
+Write Code
+==========
+
+What are you Doing???
+---------------------
+
+If you want to resolve an issue, then find one that is open and unresolved.
+
+If you want to implement a BEP, then pick one you believe you can implement. You can ask for help, but not to do *everything*.
+All BEPs are in the `bigchaindb/BEPs <https://github.com/bigchaindb/BEPs>`_ repository on GitHub.
+
+Tell us what you're doing so we don't do it too. You can tell us on Gitter or by email.
+
+
+Refresh Yourself about the C4 Process
+-------------------------------------
+
+C4 is the Collective Code Construction Contract. It's quite short:
+`re-reading it will only take a few minutes <https://github.com/bigchaindb/BEPs/tree/master/1>`_.
+
+
+Set Up Your Local Machine. Here's How.
+--------------------------------------
+
+- Get a text editor. Internally, we like:
+
+  - Vim
+  - PyCharm
+  - Visual Studio Code
+  - Atom
+  - GNU Emacs (Trent is crazy)
+  - GNU nano (Troy has lost his mind)
+
+- If you plan to do JavaScript coding, get the latest JavaScript stuff (npm etc.).
+
+- If you plan to do Python codding, get `the latest Python <https://www.python.org/downloads/>`_, and
+  get the latest ``pip``.
+
+.. warning:: 
+
+   Don't use apt or apt-get to get the latest ``pip``. It won't work properly. Use ``get-pip.py``
+   from `the pip website <https://pip.pypa.io/en/stable/installing/>`_.
+
+- Use the latest ``pip`` to get the latest ``virtualenv`` and ``pre-commit``:
+
+  .. code::
+
+     $ pip install virtualenv
+     $ pip install pre-commit
+
+
+Start Coding
+------------
+
+Use the Git `Fork and Pull Request Workflow <https://github.com/susam/gitpr>`_. Tip: print that page for reference.
+
+Your Python code should follow `our Python Style Guide <https://github.com/bigchaindb/bigchaindb/blob/master/PYTHON_STYLE_GUIDE.md>`_.
+Similarly for JavaScript.
+
+Make sure `pre-commit <https://pre-commit.com/>`_ actually checks commits. Do:
+
+  .. code::
+
+     $ pre-commit install
+
+
+The Tricky Bits
+---------------
+
+Running MongoDB and Tendermint to test stuff...
+
+But how? 
+
+You can look up how to install them, configure them, and run them. But the details are hazy.
+
+This is where we need some advice and help.
+
+Vanshdeep was going to write what he does. TODO: add that here.
+
+What about a multi-node setup? Even more confusing.
+
+
+Run the Tests Locally
+---------------------
+
+This is also unclear. I mean, use pytest, but how, exactly? Again MongoDB and Tendermint are probably needed sometimes.
+
+
+Create the PR on GitHub
+-----------------------
+
+Git push your branch to GitHub so as to create a pull request against the branch where the code you want to change *lives*.
+
+Travis and Codecov will run and might complain. Look into the complaints and fix them before merging.
+
+
+First-Time Pull Requests from External Users
+--------------------------------------------
+
+First-time pull requests from external users who haven't contributed before will get blocked by the requirement to agree to the
+BigchainDB Contributor License Agreement (CLA). It doesn't take long to agree to it. Go to
+`https://www.bigchaindb.com/cla/ <https://www.bigchaindb.com/cla/>`_ and:
+
+- Select the CLA you want to agree to (for individuals or for a whole company)
+- Fill in the form and submit it
+- Wait for an email from us with the next step. There is only one: copying a special block of text to GitHub.
+
+
+Merge!
+------
+
+Ideally, we like your PR and merge it right away. We don't want to keep you waiting.
+
+If we want to make changes, we'll do them in a follow-up PR.
+
+-----------------
+
+You are awesome. We will send swag if you let us. Do you want a job? Apply! Berlin is great. Meet the pandas. Say hi to Angela Merkel. Walk along the Under den Linden. See where Einstein and Planck taught university. Contemplate the speed of light on the actual Potsdamer Platz platform.
+
+See the former location of the telescope that first revealed the planet Neptune to human eyes. (The telescope is now in Munich.) Fresh spargel in the spring! Fresh kurbis in the fall! Rain all winter. The weather is perfect. You will love it.
+
+`Unsplash photos of Berlin <https://unsplash.com/search/photos/berlin>`_
+
+
+

docs/contributing/source/ways-can-contribute/write-docs.md

@@ -0,0 +1,23 @@
+# Write Docs
+
+If you're writing code, you should also update any related docs. However, you might want to write docs only, such as:
+
+- General explainers
+- Tutorials
+- Courses
+- Code explanations
+- How BigchainDB relates to other blockchain things
+- News from recent events
+
+You can certainly do that!
+
+- The docs for BigchainDB Server live under ``bigchaindb/docs/`` in the ``bigchaindb/bigchaindb`` repo.
+- There are docs for the Python driver under ``bigchaindb-driver/docs/`` in the ``bigchaindb/bigchaindb-driver`` repo.
+- There are docs for the JavaScript driver under ``bigchaindb/js-bigchaindb-driver`` in the ``bigchaindb/js-bigchaindb-driver`` repo.
+- The source code for the BigchainDB website is in a private repo, but we can give you access if you ask.
+
+The IPDB Transaction Spec currently lives in the ``ipdb/ipdb-tx-spec`` repo, but we'll probably move it.
+
+You can write the docs using Markdown (MD) or RestructuredText (RST). Sphinx can understand both. RST is more powerful.
+
+ReadTheDocs will automatically rebuild the docs whenever a commit happens on the ``master`` branch, or on one of the other branches that it is monitoring.