README.md and CONTRIBUTING.md out of date #3729
Description
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:
- make the links look better (remove spaces between
[]and()) - link to http://dataverse.org/goals-roadmap-and-releases
- mention the fact that Dataverse has APIs and link to API Guide
- link to CONTRIBUTING.md (updated recently in Update CONTRIBUTING.md (out of date) #2594)
- link to related repos (dataverse-ansible et al.)
- link to the Dev Guide
- link to http://dataverse.org/developers
- reword "The Dataverse code is open-source and free."
- mention dataverse-community Google Group
- possibly, mention community calls
- possibly, add a screenshot
- possibly, show code coverage from "develop" rather than "master"
- possibly, add badge for Waffle like Zelig has at https://github.com/IQSS/Zelig/blob/master/README.md
- possibly, add badge for freenode, like this:
README.md as of 4.6.1:
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.
