Skip to content
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

Add a CONTRIBUTING.md file. #425

Merged
merged 1 commit into from Apr 26, 2018
Merged

Conversation

mblayman
Copy link
Collaborator

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

For #424

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

For django-json-api#424
@mblayman
Copy link
Collaborator Author

@sliverc, @n2ygk, you both might want to look at this and let me know what you think I should add. I'm not sure what bits of knowledge about this project are locked away in my brain that I need to let out. 😄

@codecov-io
Copy link

Codecov Report

Merging #425 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e501b04...996a0a2. Read the comment docs.

Copy link
Member

@sliverc sliverc left a 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.

@mblayman mblayman merged commit f3dfa29 into django-json-api:master Apr 26, 2018
@mblayman mblayman deleted the contributing branch April 26, 2018 15:08
@@ -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
Copy link
Contributor

@n2ygk n2ygk Apr 28, 2018

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)
Copy link
Contributor

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...

Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants