global: release checklist

* FIX Adds changes according to release preparation checklist.

Signed-off-by: Paulina Lach <paulina.malgorzata.lach@cern.ch>

.editorconfig

@@ -37,9 +37,10 @@ charset = utf-8
 indent_size = 4
 # isort plugin configuration
 known_first_party = invenio_indexer
-known_third_party = invenio_db,invenio_search,invenio_records
+known_third_party = invenio_records,invenio_search
 multi_line_output = 2
 default_section = THIRDPARTY
+skip = .eggs
 
 # RST files (used by sphinx)
 [*.rst]

.gitignore

@@ -58,5 +58,8 @@ docs/_build/
 # PyBuilder
 target/
 
+# Vim swapfiles
+.*.sw?
+
 # examples
 examples/*.db

CONTRIBUTING.rst

@@ -53,9 +53,9 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `invenio` for local development.
+Ready to contribute? Here's how to set up `invenio-indexer` for local development.
 
-1. Fork the `invenio` repo on GitHub.
+1. Fork the `inveniosoftware/invenio-indexer` repo on GitHub.
 2. Clone your fork locally:
 
    .. code-block:: console
@@ -95,7 +95,12 @@ Ready to contribute? Here's how to set up `invenio` for local development.
    .. code-block:: console
 
       $ git add .
-      $ git commit -s -m "Your detailed description of your changes."
+      $ git commit -s
+          -m "component: title without verbs"
+          -m "* NEW Adds your new feature."
+          -m "* FIX Fixes an existing issue."
+          -m "* BETTER Improves and existing feature."
+          -m "* Changes something that should not be visible in release notes."
       $ git push origin name-of-your-bugfix-or-feature
 
 7. Submit a pull request through the GitHub website.

MANIFEST.in

@@ -32,6 +32,7 @@ include .lgtm
 include LICENSE
 include MAINTAINERS
 include pytest.ini
+prune docs/_build
 recursive-include docs *.bat
 recursive-include docs *.py
 recursive-include docs *.rst

README.rst

@@ -21,9 +21,9 @@
     waive the privileges and immunities granted to it by virtue of its status
     as an Intergovernmental Organization or submit itself to any jurisdiction.
 
-=================
- Invenio-Indexer
-=================
+===============
+Invenio-Indexer
+===============
 
 .. image:: https://img.shields.io/travis/inveniosoftware/invenio-indexer.svg
         :target: https://travis-ci.org/inveniosoftware/invenio-indexer

docs/conf.py

@@ -25,9 +25,13 @@
 from __future__ import print_function
 
 import os
+import sys
 
 import sphinx.environment
 
+# Plug example application into module path
+sys.path.append('examples')
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

setup.py

@@ -47,7 +47,7 @@
 
 extras_require = {
     'docs': [
-        'Sphinx>=1.4.4',
+        'Sphinx>=1.5.1'
     ],
     'tests': tests_require,
 }
@@ -119,6 +119,6 @@
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: Implementation :: CPython',
         'Programming Language :: Python :: Implementation :: PyPy',
-        'Development Status :: 1 - Planning',
+        'Development Status :: 4 - Beta',
     ],
 )

tests/test_examples_app.py

@@ -37,25 +37,30 @@
 def example_app():
     """Example app fixture."""
     current_dir = os.getcwd()
-    # go to example directory
+
+    # Go to example directory
     project_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
     exampleappdir = os.path.join(project_dir, 'examples')
     os.chdir(exampleappdir)
-    # setup example
+
+    # Setup example
     cmd = './app-setup.sh'
     exit_status = subprocess.call(cmd, shell=True)
     assert exit_status == 0
-    # setup example
+
+    # Setup example
     cmd = './app-fixtures.sh'
     exit_status = subprocess.call(cmd, shell=True)
     assert exit_status == 0
     time.sleep(10)
-    # return webapp
+    # Return webapp
     yield exit_status
-    # tear down example app
+
+    # Tear down example app
     cmd = './app-teardown.sh'
     subprocess.call(cmd, shell=True)
-    # return to the original directory
+
+    # Return to the original directory
     os.chdir(current_dir)