forked from IQSS/dataverse
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
various improvements to CONTRIBUTING.md IQSS#2594
- Remove mention of FRDs, which we don't create anymore. - Delete "feature request process" and feature-request-process.png - http://datascience.iq.harvard.edu/dataverse/support was a 404 - Add link to roadmap. - Add section on usability testing. - Remove section on issue labels (out of date). - Remove section on milestones (out of date). - Add note about emailing support if no response to a GitHub comment.
- Loading branch information
Showing
2 changed files
with
8 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,25 +6,20 @@ Thank you for your interest in contributing to Dataverse! We welcome contributio | |
|
|
||
| Your idea or feature request might already be captured in the Dataverse [issue tracker] on GitHub but if not, the best way to bring it to the community's attention is by posting on the [dataverse-community Google Group][]. You're also welcome make some noise in the [#dataverse IRC channel][] (which is [logged][]) or cram your idea into 140 characters and mention [@dataverseorg][] on Twitter. To discuss your idea privately, please email it to [email protected] | ||
|
|
||
| Once an idea/feature request has been received by the Dataverse Development Team the process outlined in the image below happens. | ||
|
|
||
|  | ||
|
|
||
| A [Functional Requirements Document (FRD for short)] [] is where we outline the use cases, requirements, user interface workflows, and any questions we have before development of a feature begins. All FRDs are publicly available through a link that is added to the github issue for the idea/feature request. Once an FRD has been completed and reviewed, low fidelity mockups are created using [Balsamiq] [] so we know what the user interface and user experience will be once the feature is developed. The mockups are also publicly available through a link added to the github issue for the idea/feature request. Please feel free to comment on any FRDs and mockups! | ||
|
|
||
| To review FRDs for Dataverse, you can access them in this [Functional Requirements Document folder on Google Drive]. | ||
|
|
||
| See also our [Community and Support][] page. | ||
| There's a chance your idea is already on our roadmap, which is available at http://dataverse.org/goals-roadmap-and-releases | ||
|
|
||
| [#dataverse IRC channel]: http://chat.dataverse.org | ||
| [logged]: http://irclog.iq.harvard.edu/dataverse/today | ||
| [issue tracker]: https://github.com/IQSS/dataverse/issues | ||
| [@dataverseorg]: http://twitter.com/dataverseorg | ||
| [Community and Support]: http://datascience.iq.harvard.edu/dataverse/support | ||
| [Functional Requirements Document (FRD for short)]: https://docs.google.com/document/d/1PRyAlP6zlUlUuHfgyUezzuaVQ4JnapvgtGWo0o7tLEs/edit?usp=sharing | ||
| [Balsamiq]: https://iqssharvard.mybalsamiq.com/projects | ||
| [Functional Requirements Document folder on Google Drive]: https://drive.google.com/folderview?id=0B3_V6vFxEcx-fl92ek92OG1nTmhQenBRX1Z4OVJBLXpURmh2d2RyX1NZRUp6YktaYUU5YTA&usp=sharing | ||
|
|
||
| ## Usability testing | ||
|
|
||
| Please email us at [email protected] if you are interested in participating in usability testing. | ||
|
|
||
| ## Bug Reports/Issues | ||
|
|
||
| An issue is a bug (a feature is no longer behaving the way it should) or a feature (something new to Dataverse that helps users complete tasks). You can browse the Dataverse [issue tracker] on GitHub by open or closed issues or by milestones. | ||
|
|
@@ -33,36 +28,18 @@ Before submitting an issue, please search the existing issues by using the searc | |
|
|
||
| If there is no pre-existing issue, please click on the "New Issue" button, log in, and write in what the issue is (unless it is a security issue which should be reported privately to [email protected]). Someone on the Dataverse development team will appropriately tag and assign it to a member of the Dataverse development team. | ||
|
|
||
| ## Writing an Issue | ||
|
|
||
| For the subject of an issue, please start it by writing the feature or functionality it relates to, i.e.-Create Account: or Dataset Page:. In the body of the issue, please outline the issue you are reporting with as much detail as possible. In order for the Dataverse development team to best respond to the issue, we need as much information about the issue as you can provide. Include steps to reproduce bugs. Indicate which version you're using. We love screenshots! | ||
| If you do not receive a reply to your new issue or comment in a timely manner, please email [email protected] with a link to the issue. | ||
|
|
||
| ### Issue Labels | ||
| ## Writing an Issue | ||
|
|
||
| - **Component**: specifies the part of Dataverse the issue relates to | ||
| - **Priority**: | ||
| - **Critical**: needs to be fixed right away, prevents a user from completing a task | ||
| - **High**: it’s a priority to be completed for the assigned milestone | ||
| - **Medium**: planned for that milestone, but if needed, it can be re-considered | ||
| - **Status**: | ||
| - **In Dev**: being developed | ||
| - **In QA**: testing to make sure it is behaving as wanted | ||
| - **Type**: | ||
| - **Bug** | ||
| - **Feature** | ||
| - **Suggestion** | ||
| For the subject of an issue, please start it by writing the feature or functionality it relates to, i.e. "Create Account:..." or "Dataset Page:...". In the body of the issue, please outline the issue you are reporting with as much detail as possible. In order for the Dataverse development team to best respond to the issue, we need as much information about the issue as you can provide. Include steps to reproduce bugs. Indicate which version you're using. We love screenshots! | ||
|
|
||
| ### Issue Attachments | ||
|
|
||
| You can attach certain files (images, screenshots, logs, etc.) by dragging and dropping, selecting them, or pasting from the clipboard. Files must be one of GitHub's [supported attachment formats] such as png, gif, jpg, txt, pdf, zip, etc. (Pro tip: A file ending in .log can be renamed to .txt so you can upload it.) If there's no easy way to attach your file, please include a URL that points to the file in question. | ||
|
|
||
| [supported attachment formats]: https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/ | ||
|
|
||
| ## Milestones | ||
| - **In Review**: milestone for issues that are being reviewed for future releases | ||
| - **In Design**: milestone for issues that are being designed (FRDs, mockups, technical specifications, etc happen during this milestone). This is a way to see what we are working on for future releases | ||
| - **Candidate** candidate for [version] means that it is only under consideration. A developer works on issues that have been tagged with a particular milestone before dipping into the corresponding "candidate for" milestone. Usually are "nice to have" features or bug fixes for a release if there is time left after the primary work is done. | ||
|
|
||
| ## Documentation | ||
|
|
||
| The source for the documentation at http://guides.dataverse.org is in the GitHub repo under the "[doc][]" folder. If you find a typo or inaccuracy or something to clarify, please send us a pull request! For more on the tools used to write docs, please see the [documentation][] section of the Developer Guide. | ||
|
|
||
Binary file not shown.