|
1 | 1 | # Contributing to Dataverse |
2 | 2 |
|
3 | | -Thank you for your interest in contributing to Dataverse! We welcome contributions of ideas, bug reports, documentation, code, and more! |
| 3 | +Thank you for your interest in contributing to Dataverse! We welcome contributions of ideas, bug reports, usability testing, documentation, code, and more! |
4 | 4 |
|
5 | 5 | ## Ideas/Feature Requests |
6 | 6 |
|
7 | | -Your idea or feature request might already be captured in the collection of [Dataverse issues] 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][] or cram your idea into 140 characters and mention [@dataverseorg][] on Twitter. |
| 7 | +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] |
8 | 8 |
|
9 | | -Once an idea/feature request has been received by the Dataverse Development Team the process outlined in the image below happens. |
| 9 | +There's a chance your idea is already on our roadmap, which is available at http://dataverse.org/goals-roadmap-and-releases |
10 | 10 |
|
11 | | - |
12 | | - |
13 | | -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! |
14 | | - |
15 | | -To review FRDs for Dataverse, you can access them in this [Functional Requirements Document folder on Google Drive]. |
16 | | - |
17 | | -See also our [Community and Support][] page. |
18 | | - |
19 | | -[#dataverse IRC channel]: http://webchat.freenode.net/?channels=dataverse |
20 | | -[Dataverse issues]: https://github.com/IQSS/dataverse/issues |
| 11 | +[#dataverse IRC channel]: http://chat.dataverse.org |
| 12 | +[logged]: http://irclog.iq.harvard.edu/dataverse/today |
| 13 | +[issue tracker]: https://github.com/IQSS/dataverse/issues |
21 | 14 | [@dataverseorg]: http://twitter.com/dataverseorg |
22 | | -[Community and Support]: http://datascience.iq.harvard.edu/dataverse/support |
23 | 15 | [Functional Requirements Document (FRD for short)]: https://docs.google.com/document/d/1PRyAlP6zlUlUuHfgyUezzuaVQ4JnapvgtGWo0o7tLEs/edit?usp=sharing |
24 | 16 | [Balsamiq]: https://iqssharvard.mybalsamiq.com/projects |
25 | 17 | [Functional Requirements Document folder on Google Drive]: https://drive.google.com/folderview?id=0B3_V6vFxEcx-fl92ek92OG1nTmhQenBRX1Z4OVJBLXpURmh2d2RyX1NZRUp6YktaYUU5YTA&usp=sharing |
26 | 18 |
|
| 19 | +## Usability testing |
| 20 | + |
| 21 | +Please email us at [email protected] if you are interested in participating in usability testing. |
| 22 | + |
27 | 23 | ## Bug Reports/Issues |
28 | 24 |
|
29 | 25 | 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. |
30 | 26 |
|
31 | | -[issue tracker]: https://github.com/IQSS/dataverse/issues |
32 | | - |
33 | 27 | Before submitting an issue, please search the existing issues by using the search bar at the top of the page. If there is an existing issue that matches the issue you want to report, please add a comment to it. |
34 | 28 |
|
35 | 29 | 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. |
36 | 30 |
|
37 | | -## Writing an Issue |
| 31 | +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. |
38 | 32 |
|
39 | | -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. |
| 33 | +### Writing an Issue |
40 | 34 |
|
41 | | -### Issue Labels |
42 | | - |
43 | | -- **Component**: specifies the part of Dataverse the issue relates to |
44 | | -- **Priority**: |
45 | | - - **Critical**: needs to be fixed right away, prevents a user from completing a task |
46 | | - - **High**: it’s a priority to be completed for the assigned milestone |
47 | | - - **Medium**: planned for that milestone, but if needed, it can be re-considered |
48 | | -- **Status**: |
49 | | - - **In Dev**: being developed |
50 | | - - **In QA**: testing to make sure it is behaving as wanted |
51 | | -- **Type**: |
52 | | - - **Bug** |
53 | | - - **Feature** |
54 | | - - **Suggestion** |
| 35 | +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! |
55 | 36 |
|
56 | 37 | ### Issue Attachments |
57 | 38 |
|
58 | | -You can attach an image or screenshot by dragging and dropping, selecting them, or pasting from the clipboard. This file must be a [supported image format] such as PNG, GIF or JPG; otherwise you will have to include a URL that points to the file in question. |
59 | | - |
60 | | -[supported image format]: https://help.github.com/articles/issue-attachments |
| 39 | +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. |
61 | 40 |
|
62 | | -## Milestones |
63 | | - - **In Review**: milestone for issues that are being reviewed for future releases |
64 | | - - **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 |
65 | | - - **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. |
| 41 | +[supported attachment formats]: https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/ |
66 | 42 |
|
67 | 43 | ## Documentation |
68 | 44 |
|
69 | | -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! |
| 45 | +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. |
| 46 | + |
| 47 | +[doc]: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source |
| 48 | +[documentation]: http://guides.dataverse.org/en/latest/developers/documentation.html |
70 | 49 |
|
71 | 50 | ## Code/Pull Requests |
72 | 51 |
|
73 | | -To get started developing code for Dataverse, please read our Developer Guide at http://guides.dataverse.org/en/latest/developers |
| 52 | +Before you start coding, please reach out to us either on the [dataverse-community Google Group][], the [dataverse-dev Google Group][], [IRC][] (#dataverse on freenode), or via support@dataverse.org to make sure the effort is well coordinated and we avoid merge conflicts. |
74 | 53 |
|
75 | | -[doc]: https://github.com/IQSS/dataverse/tree/master/doc/sphinx-guides/source |
| 54 | +We will encourage you to create a GitHub issue (if it doesn't exist already) to associate with your pull request. |
76 | 55 |
|
77 | | -Before you start coding, please reach out to us either on our [dataverse-community Google Group][], [IRC][], or via support@dataverse.org to make sure the effort is well coordinated and we avoid merge conflicts. |
| 56 | +We hope you find the Developer Guide at http://guides.dataverse.org/en/latest/developers helpful. |
78 | 57 |
|
79 | | -[dataverse-community Google Group]: https://groups.google.com/group/dataverse-community |
80 | | -[IRC]: http://irclog.iq.harvard.edu/dataverse/today |
| 58 | +After making your pull request, your goal should be to help it advance through our kanban board at https://waffle.io/IQSS/dataverse . If no one has moved your pull request to the code review column in a timely manner, please reach out. Thanks! |
81 | 59 |
|
82 | | -If your pull request is not assigned to anyone in a timely manner, please reach out. The assignee is responsible for evaluating the pull request and deciding whether or not to merge it in. Please try to make it easy to merge in pull requests. Tests are great. :) |
| 60 | +[dataverse-community Google Group]: https://groups.google.com/group/dataverse-community |
| 61 | +[dataverse-dev Google Group]: https://groups.google.com/group/dataverse-dev |
| 62 | +[IRC]: http://chat.dataverse.org |
0 commit comments