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

Update README following DESC guidelines. #193

Merged
merged 7 commits into from
Dec 14, 2018
Merged

Conversation

cwwalter
Copy link
Member

Hi Rachel,

Please take a look at this new version of the README as you requested.

BTW, I think found an issue in the DESC instructions. If a code is open source (and as specified by our License file) others are free to use it and must include our copyright notice etc. There aren't any other requirements. Yet the file you showed me suggests we include:

"We welcome requests to access the code for non-DESC use; if you wish to use the code outside DESC please contact the developers."

I have left this out as it only makes sense for private not open source repos.

@rmjarvis
Copy link
Contributor

rmjarvis commented Nov 28, 2018

I think that line you left out is directed at other DESC members. Internally, our pub guidelines say that DESC members who want to use unpublished DESC resources for non-DESC purposes need to get special clearance. So it's not a legal requirement (as you point out re the license), but a self-imposed collaboration obligation.

(But the current wording doesn't make that clear, so probably some reworking of that line is in order.)

@coveralls
Copy link

coveralls commented Nov 28, 2018

Coverage Status

Coverage increased (+0.5%) to 73.32% when pulling 6c1e7c2 on u/cwwalter/update_readme into 5d8ef80 on master.

@cwwalter
Copy link
Member Author

(But the current wording doesn't make that clear, so probably some reworking of that line is in order.)

Hmm... Yes... currently it looks like this:

screen shot 2018-11-28 at 11 55 00 am

Maybe it would be better to split it and make it clear when to add that part.

Copy link

@rmandelb rmandelb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cwwalter - this looks like a significant improvement to me! It's especially helpful that you've clarified the release status and given a link to the wiki with documentation.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rmandelb
Copy link

Thanks for this, Chris!

@cwwalter cwwalter merged commit 037a8e3 into master Dec 14, 2018
@cwwalter cwwalter deleted the u/cwwalter/update_readme branch December 14, 2018 02:23
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