Skip to content

Commit

Permalink
CONTRIBUTING.md: various improvements IQSS#2594
Browse files Browse the repository at this point in the history 
Changes from top to bottom of this doc:

- Say it's ok to email support privately about ideas.
- Standardize on calling GitHub issue the "issue tracker".
- Link to http://chat.dataverse.org rather than freenode web interface
  and explicitly mention IRC logs.
- When writing an issue, include steps to reproduce, version number, and
  screenshots.
- Explain that many more attachment formats are now accepted.
- Link to new documentation section of dev guide.
- Link to doc folder in "develop" rather than "master".
  • Loading branch information
@pdurbin
pdurbin committed Jan 29, 2016
1 parent d65b905 commit b622805
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for your interest in contributing to Dataverse! We welcome contributio

## Ideas/Feature Requests

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.
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 support@dataverse.org

Once an idea/feature request has been received by the Dataverse Development Team the process outlined in the image below happens.

Expand All @@ -16,8 +16,9 @@ To review FRDs for Dataverse, you can access them in this [Functional Requiremen

See also our [Community and Support][] page.

[#dataverse IRC channel]: http://webchat.freenode.net/?channels=dataverse
[Dataverse issues]: https://github.com/IQSS/dataverse/issues
[#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
Expand All @@ -28,15 +29,13 @@ See also our [Community and Support][] page.

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 (unless it is a security issue which should be reported privately to security@dataverse.org). 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.
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 Labels

Expand All @@ -55,9 +54,9 @@ For the subject of an issue, please start it by writing the feature or functiona

### 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.
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 image format]: https://help.github.com/articles/issue-attachments
[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
Expand All @@ -66,17 +65,18 @@ You can attach an image or screenshot by dragging and dropping, selecting them,

## 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!
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.

[doc]: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source
[documentation]: http://guides.dataverse.org/en/latest/developers/documentation.html

## Code/Pull Requests

To get started developing code for Dataverse, please read our Developer Guide at http://guides.dataverse.org/en/latest/developers

[doc]: https://github.com/IQSS/dataverse/tree/master/doc/sphinx-guides/source

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
[IRC]: http://chat.dataverse.org

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. :)

0 comments on commit b622805

Please sign in to comment.