We very much welcome contributions! Before contributing there are a few things that you should know about the neo4j.rb projects:
The Neo4j.rb Project¶
We try to follow semantic versioning based on semver.org <http://semver.org/>
Low Hanging Fruit¶
Just reporting issues is helpful, but if you want to help with some code we label our GitHub issues with
low-hanging-fruit to make it easy for somebody to start helping out:
Help or discussion on other issues is welcome, just let us know!
Communicating With the Neo4j.rb Team¶
GitHub issues are a great way to submit new bugs / ideas. Of course pull requests are welcome (though please check with us first if it’s going to be a large change).
Before you submit your pull request¶
Please try to check at least the RSpec tests and Rubocop before making your pull request.
.overcommit.yml files are available if you would like to use
guard (for RSpec and rubocop) and/or overcommit.
We also use Travis CI to make sure all of these pass for each pull request. Travis runs the specs across multiple versions of Ruby and multiple Neo4j databases, so be aware of that for potential build failures.
To aid our users, we try to keep a complete
CHANGELOG.md file. We use keepachangelog.com as a guide. We appreciate a line in the
CHANGELOG.md as part of any changes.
We also use Sphinx / reStructuredText for our documentation which is published on readthedocs.org. We also appreciate your help in documenting any user-facing changes.
Notes about our documentation setup:
- YARD documentation in code is also parsed and placed into the Sphinx site so that is also welcome. Note that reStructuredText inside of your YARD docs will render more appropriately.
- You can use
rake docsto build the documentation locally and
rake docs:opento open it in your web browser.
- Please make sure that you run
rake docsbefore committing any documentation changes and checkin all changes to