This document present how you can contribute to the OpenRefine project. Please review also our Governance model
Documentation, Questions or Problem
Our issue list is only for reporting specific bugs and requesting specific features. If you just don't know how to do something using OpenRefine, or want to discuss some ideas, please
If you really want to file a bug or request a feature, go to this issue list. Please use the search function first to make sure a similar issue doesn't already exist.
Guidelines for Reporting a Bug
When reporting a bug please provide the following information to help reproduce the bug:
- Version of OpenRefine used (Google Refine 2.6, OpenRefine2.7, an other distribution?)
- Operating Systems and version
- Browser + version used - Please note that OpenRefine doesn't support Internet Explorer
- Steps followed to create the issue
- If you are allowed, it is awesome if you can include the data generating the issue
- Current Results
- Expected Results
You don't need to be coder to contribute to OpenRefine. Did you write a tutorial or article about OpenRefine on your blog or site? Are you organizing a workshop or presentation for OpenRefine in your city? Let us know via our user discussion list or Twitter account (@OpenRefine). We will share the news via our monthly update and via our Twitter handle.
You can contribute code in three different ways:
- Fix minor bugs - you can check the issues flagged as help wanted or good first issue
- Develop an OpenRefine extension
- Start your own distribution or fork
All developers including new distributions and plugin developers are invited to leverage the following OpenRefine project management areas to avoid the dispersion of the community in different communication channels.
- the wiki for shared documentation between both user docs and documentation for developer
- the developer mailing list for technical questions, new feature development and anything code related. We invite you to share you idea first via the developer mailing list. Someone may be able to point out to existing development saving you hours of research and development.
- OpenRefine github issue tracker for requesting new features and bug reports.
How to submit PR's (pull requests), patches, and bug fixes
- Avoid merging master in your branch because it makes code review a lot harder.
- If you want to keep your branch up to date with our master, it would be nicer if you could just rebase your branch instead. That would keep the history a lot cleaner.
- Please avoid adding unrelated changes in the PR. Do a separate PR and rebase once they get merged can work really well.
If you make trivial changes, you can send them directly via a pull request. Please make your changes in a new git branch and send your patch, including appropriate test cases.
We want to keep the quality of the trunk at a very high level, since this is ultimately where the Stable Releases are built from after bugs are fixed. Please take the time to test your changes (including travis-ci) before sending a pull request.
OpenRefine is volunteer supported. Pull Requests are reviewed and merged by volunteers. All Pull Requests will be answered, however it may take some time to get back to you. Thank you in advance for your patience.
If you don't know where to start and are looking for a bug to fix, please see our issue list.
New functionalities via extensions
OpenRefine support a plugin architecture to extend its functionality. You can find more information on how to write extension on our wiki. Giuliano Tortoreto wrote a separate documentation detailling how to build extension for OpenRefine. A LaTeX and PDF version are available.
If you want to list your extension on the download page, please edit this file.
OpenRefine is already available in many different distributions (see the download page). New distributions often package OpenRefine for a specific usage or port it. We are fine with new forks (see discussion) but we invite you to engage with the community to share your roadmap and progress.
Github offers a powerful system to work between different repositories and we encourage you to leverage it:
- You can cross reference issues and pull requests between Github repository using
user/repository#number(see more here)
- If you want to merge a Pull Request that is pending for review to your own repository check the pull request locally (see more here).
Don't forget to contribute to the upstream (main OpenRefine) repository so your changes from your distribution can be reviewed and merged and to keep other developers aware of your progress. If you want to list your distribution on the download page, please edit this file.