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

README.md and CONTRIBUTING.md out of date #3729

Closed
pdurbin opened this issue Mar 28, 2017 · 2 comments
Closed

README.md and CONTRIBUTING.md out of date #3729

pdurbin opened this issue Mar 28, 2017 · 2 comments

Comments

@pdurbin
Copy link
Member

pdurbin commented Mar 28, 2017

README.md

https://github.com/IQSS/dataverse/blob/v4.6.1/README.md weird looking links (screenshot below) and lines such as "Dataverse 4.0 is now released" which is true but fairly out of date. We're up to 4.6.1 as of this writing. In addition, I recommend the following:

README.md as of 4.6.1:

screen shot 2017-03-31 at 4 14 14 pm

CONTRIBUTING.md

Improvements have been made in #2594 but some parts are still out of date:

  • [After a new issue is created] "Someone on the Dataverse development team will appropriately tag and assign it to a member of the Dataverse development team." It may be tagged but we don't assign issues in this way anymore. We've switched to a "pull" model and we pull from items in a particular sprint. (Not that we need to get into this degree of detail.)
  • Link to "Dataverse Community Contributors" spreadsheet at https://docs.google.com/spreadsheets/d/1o9DD-MQ0WkrYaEFTD5rF_NtyL8aUISgURsAXSL7Budk/edit?usp=sharing

PULL_REQUEST_TEMPLATE.md

  • Consider changing suggested "connect to" example to prevent connects to [#3666]: [provide a production-ready example of robots.txt in the guides] which doesn't link pull requests to issues in Waffle due to the brackes ([]). See screenshot below.

screen shot 2017-04-28 at 10 29 42 am

@pdurbin pdurbin changed the title README.md out of date README.md, CONTRIBUTING.md out of date Apr 6, 2017
@pdurbin pdurbin changed the title README.md, CONTRIBUTING.md out of date README.md out of date, tweask to it, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md Apr 28, 2017
@pdurbin pdurbin changed the title README.md out of date, tweask to it, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md README.md out of date, tweaks to it, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md May 21, 2017
@pdurbin pdurbin self-assigned this Jun 9, 2017
@pdurbin
Copy link
Member Author

pdurbin commented Jun 20, 2017

@dlmurphy fixed the pull request template yesterday in 7076bdc

pdurbin added a commit that referenced this issue Jun 20, 2017
pdurbin added a commit that referenced this issue Jun 20, 2017
@pdurbin pdurbin mentioned this issue Jun 20, 2017
5 tasks
@pdurbin
Copy link
Member Author

pdurbin commented Jun 20, 2017

I rolled some fixes into README.md and CONTRIBUTING.md into pull request #3892 and am moving this issue to Code Review at https://waffle.io/IQSS/dataverse

@pdurbin pdurbin removed their assignment Jun 20, 2017
@pdurbin pdurbin changed the title README.md out of date, tweaks to it, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md README.md and CONTRIBUTING.md out of date Jun 20, 2017
@pdurbin pdurbin closed this as completed Jun 20, 2017
@djbrooke djbrooke added this to the 4.7 - Dashboard and Customization milestone Jun 21, 2017
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

No branches or pull requests

2 participants