From 996a0a2fc432e846aa85edd033c9b386ccb1f270 Mon Sep 17 00:00:00 2001
From: Matt Layman <matthewlayman@gmail.com>
Date: Wed, 25 Apr 2018 20:27:51 -0400
Subject: [PATCH] Add a CONTRIBUTING.md file.

This branch adds a skeleton of contribution guidelines and cleans up
little bits that I noticed along the way.

For #424
---
 LICENSE                      |  2 +-
 docs/CONTRIBUTING.md         | 30 ++++++++++++++++++++++++++++++
 docs/_static/.gitkeep        |  0
 docs/conf.py                 |  8 +++++---
 docs/index.rst               |  1 +
 requirements-development.txt |  7 ++++---
 6 files changed, 41 insertions(+), 7 deletions(-)
 create mode 100644 docs/CONTRIBUTING.md
 create mode 100644 docs/_static/.gitkeep

diff --git a/LICENSE b/LICENSE
index ed0db152..8c11d568 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2014 nGen Works Company and individual contributors.
+Copyright (c) 2018 nGen Works Company and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
new file mode 100644
index 00000000..5ab82991
--- /dev/null
+++ b/docs/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+Contributing
+============
+
+DJA should be easy to contribute to.
+If anything is unclear about how to contribute,
+please submit an issue on GitHub so that we can fix it!
+
+How
+---
+
+Before writing any code,
+have a conversation on a GitHub issue
+to see if the proposed change makes sense
+for the project.
+
+Fork DJA on [GitHub](https://github.com/django-json-api/django-rest-framework-json-api) and
+[submit a Pull Request](https://help.github.com/articles/creating-a-pull-request/)
+when you're ready.
+
+For maintainers
+---------------
+
+To upload a release (using version 1.2.3 as the example):
+
+```bash
+(venv)$ python setup.py sdist bdist_wheel
+(venv)$ twine upload dist/*
+(venv)$ git tag -a v1.2.3 -m 'Release 1.2.3'
+(venv)$ git push --tags
+```
diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/conf.py b/docs/conf.py
index 76c5f14c..7a61ea8a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,6 +13,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import datetime
 import sys
 import os
 import shlex
@@ -52,8 +53,9 @@
 
 # General information about the project.
 project = 'Django REST Framework JSON API'
-copyright = '2015, Jerel Unruh and contributors'
-author = 'Jerel Unruh'
+year = datetime.date.today().year
+copyright = '{}, Django REST Framework JSON API contributors'.format(year)
+author = 'Django REST Framework JSON API 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
@@ -235,7 +237,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   (master_doc, 'DjangoRESTFrameworkJSONAPI.tex', 'Django REST Framework JSON API Documentation',
-   'Jerel Unruh', 'manual'),
+   'Django REST Framework JSON API contributors', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
diff --git a/docs/index.rst b/docs/index.rst
index a9d4a7fc..b18b8b6e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,7 @@ Contents:
    getting-started
    usage
    api
+   CONTRIBUTING
 
 Indices and tables
 ==================
diff --git a/requirements-development.txt b/requirements-development.txt
index 2a46de82..f5c7cacb 100644
--- a/requirements-development.txt
+++ b/requirements-development.txt
@@ -1,15 +1,16 @@
 -e .
+django-debug-toolbar
 django-polymorphic>=2.0
+factory-boy
 Faker
 isort
 mock
+packaging==16.8
 pytest
 pytest-django
-factory-boy
 pytest-factoryboy
 recommonmark
 Sphinx
 sphinx_rtd_theme
 tox
-django-debug-toolbar
-packaging==16.8
+twine