-
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
Conversation
This branch adds a skeleton of contribution guidelines and cleans up little bits that I noticed along the way. For django-json-api#424
Codecov Report
@@ Coverage Diff @@
## master #425 +/- ##
=======================================
Coverage 91.75% 91.75%
=======================================
Files 55 55
Lines 2923 2923
=======================================
Hits 2682 2682
Misses 241 241 Continue to review full report at Codecov.
|
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.
Looks good to me.
@@ -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 |
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.
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 comment
The 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 comment
The 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.
This branch adds a skeleton of contribution guidelines and cleans up
little bits that I noticed along the way.
For #424