new file: CONTRIBUTING.md

ErykKul · Jul 18, 2014 · 250cbcc · 250cbcc
1 parent 4a529a3
commit 250cbcc
Showing 1 changed file with 63 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,63 @@
+# Contributing to Dataverse
+
+Thank you for your interest in contributing to Dataverse! We welcome contributions of ideas, bug reports, documentation, code, and more!
+
+## Ideas/Feature Requests
+
+The [Dataverse roadmap][] might already capture your idea or feature request 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 mentioning [@thedataorg][] on Twitter.
+
+See also our [Community and Support][] page.
+
+[#dataverse IRC channel]: http://webchat.freenode.net/?channels=dvn
+[Dataverse roadmap]: http://datascience.iq.harvard.edu/dataverse/roadmap
+[@thedataorg]: http://twitter.com/thedataorg
+[Community and Support]: http://datascience.iq.harvard.edu/dataverse/support
+
+## 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.
+
+[issue tracker]: https://github.com/IQSS/dataverse/issues
+
+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.
+
+If there is no pre-existing issue, please click on the "New Issue" button, log in, and write in what the issue is. Someone on the Dataverse development team will appropriately tag and assign it to a member of the Dataverse development team. 
+
+### Issue Labels
+
+- **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 Design**: mockups and wireframes are being created
+  - **In Dev**: being developed
+  - **In QA**: testing to make sure it is behaving as wanted
+- **Type**:
+  - **Bug**
+  - **Feature**
+  - **Suggestion**
+
+### Issue Attachments
+
+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.
+
+[supported image format]: https://help.github.com/articles/issue-attachments
+
+## Documentation
+
+All of our documentation 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!
+
+## Code/Pull Requests
+
+To get started developing code for Dataverse, please read our Developer's Guide at http://dataverse-demo.iq.harvard.edu/guides/index.html or in the "[doc][]" folder mentioned above.
+
+[doc]: https://github.com/IQSS/dataverse/tree/master/doc
+
+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.
+
+[dataverse-community Google Group]: https://groups.google.com/group/dataverse-community
+[IRC]: http://irclog.iq.harvard.edu/dataverse/today
+
+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. :)