Contributing
The DMP Roadmap project team is always eager to hear about new ideas for enhancing our shared system. We welcome any and all feedback and are interested in engaging with you to help us build the next generation of data management planning software.
There are several ways for you to get involved:
- Subscribe to our RSS feed to stay up to date on what the team is working on
- Sign up for our developer Listserv
- Watch this project on GitHub to get updates when changes are made (click 'Watch' in the upper right hand corner of this page)
An easy and valuable way to help out is by simply letting us know about any issues you encounter while using the system. We always test any changes made to the system but, as with any piece of software, there will be the occasional bug that slips by our defenses.
Please take a moment and look through the list of the existing GitHub Issues before adding a new one. Someone else may have already reported the same issue. If so, add a comment to provide additional details and to let us know that you've encountered the same issue (this will help us prioritize the issue).
The GitHub issues page provides you with a search box and labels/tags that can be used to help narrow down the list to see if its already been reported.
If you don't see the issue listed then please create a new one. Please try to be as descriptive as possible and outline the series of steps we can take to recreate the problem. For example: "I logged into the system as an organisational user, clicked edit plan (for plan X that was based on the NSF template) and got the following error message ...". Screen shots are also extremely useful.
Be sure to add labels to your issue to help us categorize and prioritize the work.
Please note that the team has limited time and resources and so must prioritize the backlog of open issues and enhancement requests accordingly.
The DMP Roadmap team welcomes your ideas for new enhancements and/or ways that we can integrate our tool into other systems. Your idea does not necessarily have to be fulled formed in order for you to get started. You can simply add a new issue to our GitHub Issues list and add the 'suggestion' label to it to begin a conversation about your idea with the team.
Please check the following lists before you create a new suggestion. It may already be on our development roadmap or someone else may have already had a similar idea and created an issue on our Suggestion list. If so, feel free to add a comment to that item and join the conversation even if its just to help promote the idea.
Don't forget to use the 'suggestion' label when creating your ticket!
The DMP Roadmap team is always looking for help with translating the system to other languages.
TODO: Add an explanation of how to help build translation files
The DMP Roadmap team is always interested in collaborating with other developers. If you are familiar with Ruby and the Rails framework and would like to help us work on our backlog of issues and enhancement requests, please follow the steps below to get involved.
- If this is a new enhancement, please follow the instructions above for 'Sharing your ideas'
- Assuming we weren't able to prioritize your suggestion and you want to start working on it ... or you're interested in helping us address our backlog of open bugs. Create a fork the DMPRoadmap/roadmap repository.
- Clone your fork onto your local machine and follow the installation instructions to setup your environment
- Create a new branch for your new feature or bug fix (
> git checkout -b my-feature) - Make your changes, commit them and then push them up to Github
- Add the appropriate tests or adjust existing tests if necessary
- Create a pull request in GitHub from your branch to the 'contributions' branch of the DMPRoadmap/roadmap repository
- The project team will review your changes and provide feedback.
Please see the developer guide for further details on contributing to the project.
All of the documentation for the DMP Roadmap project can be found on our Wiki. If you find that something is missing or if any of the documentation appears to be incorrect or out of date, please let us know.
For corrections or new contributions, please submit a new [GitHub Issue](GitHub Issues) and be sure to use the 'documentation' label to help us categorize and identify the problem. If you are providing new documentation please note that your content is new and where it should appear within the Wiki. Specify the URL of the Wiki page that the correction applies to if possible.
 |
 |