Join us in making Java a great platform for data science
Tablesaw makes it easy to use Java for data science, but we can use your help. Here are some ways you can contribute today:
- Ask or answer questions
- Improve the documentation
- Report or fix a bug
- Implement tests for existing features
- Implement new features and enhancements
- Become a project maintainer
Please use the project Issues section on Github to ask questions, tagging the issue as a “Question”.
Improve the documentation
All our docs are in the docs folder of the tablesaw repo, and they are all written in Markdown. To provide enhancements, follow the directions on how to implement featues and bugs below as the workflow is basically the same.
We could always use better test coverage. If you see a gap you’d like to fill, follow the basic Github process outlined below.
Using Github to implement features and fix bugs (and improve documentation or add tests)
If you want to help out with one of our bugs or implement a new feature, here are some suggestions for success. The basic process looks like this:
- Fork Tablesaw
- Clone your fork to your development machine
- Create your issue branch
- Implement your feature or fix the bug and push the results to your fork
- Send us a pull request.
You can find more info about creating a fork and pull request in the GitHub help articles. Our maintainers will review your pull request as soon as we can. You can find our project on Github at:
What makes a good Pull Request?
- Address only one issue with a single pull request.
- For new functionality, have a conversation with one or more maintainers before putting in too much work. Opening an issue is a good way to start the conversation
- Requests with tests are the best
- Finally, We love small pull requests. That we we can find time to review them between work, and family, and watching Game of Thrones.
What to Contribute?
“Help Wanted” labels
Among the open bugs and feature requests, we’ve tagged some as “Help Wanted”. This indicates that a fix should be relatively straightforward to address. We would, of course, LOVE help on some of the more challenging issues. Help Wanted simply means that this is a good place for a developer with limited knowlege of the library and/or limited experience with Java to jump in.
Working on the code in Eclipse
- Install e(fx)clipse. Choose the update site that came with your installation of Eclipse. E.g. “Oxygen - http://download.eclipse.org/releases/oxygen”. Then install “e(fx)clipse” under “General Purpose Tools”
Become a Maintainer/Committer
We are actively seeking new maintainers for the project. The best way to get involved is to familiarize yourself with the project through use, and make a few minor changes/fixes. After that, introduce yourself by emailing firstname.lastname@example.org and we’ll get in touch.