-
Notifications
You must be signed in to change notification settings - Fork 301
Add a CONTRIBUTING.md file. #425
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, I would think @jerel's name should be retained with special emphasis as the original creator. "and contributors" for the rest... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh wait, git says @gaker for the initial commit. Hmm... I'm still uncomfortable with removing a specific name from a copyright statement. |
||
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 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,7 @@ Contents: | |
getting-started | ||
usage | ||
api | ||
CONTRIBUTING | ||
|
||
Indices and tables | ||
================== | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mblayman Sorry for this late response. Shouldn't the copyright date not just be the current year but a range or list of years starting from when the code was first released? Or just leave it at the date of first publication? There are lots of opinions around this but it seems that by advancing the copyright notice automatically you are excluding earlier code from the copyright statement. Not that it matters much as copyright applies with or without the statement.