CONTRIBUTING.md

In nicolewhite/RNeo4j: Neo4j Driver for R

Contributing

Dependencies

• git
• R
• RStudio

Fork the Project

Fork my repository with the "Fork" button on GitHub.

Clone the Project

Clone your fork.

$ git clone https://github.com/yourusername/RNeo4j.git

In RStudio, File --> Open Project... and open the RNeo4j.Rproj file.

R Dependencies

install.packages("httr")
install.packages("jsonlite")
install.packages("testthat")

Neo4j

Get Neo4j with make download_neo4j. This will download the latest release of Neo4j and create a neo4j directory in the working directory. Start Neo4j with make start_neo4j.

Contribute Code

Update the README

If you want to add to or edit the README, make sure you make your changes in README.Rmd. This is an R Markdown file, which is converted to README.md with make readme. Once you've ran make readme, you can open the README.md file in RStudio and preview it with the "Preview HTML" button at the top.

Modify Existing Code

If you're modifying existing code, just use make test to ensure you haven't broken any existing functionality. If applicable, add some tests.

Add New Code

If you're adding a new function, add a new file to the R directory where the name of the file is the name of the function. Look at the other files in the R directory for an example. You'll also need to document your function with roxygen syntax and add tests.

Add Tests

Tests are located in the tests/testthat directory. Check out some of the current test files for examples of how to use it. Add tests to any of the existing test files in the tests directory or add a new test file for your tests if they don't fit into any of the current test file categories. The filename must be prefixed test-.

Run Tests

Run tests with make test. Neo4j must be running in order to run the tests.

Commit Your Changes

Commit the changes to your fork with a descriptive commit message. This is a good example.

$ git commit

Push Your Changes

Push the changes to your fork.

$ git push

Open a Pull Request

Go to your fork on GitHub. Click on the "Pull Request" button beneath the title. For example:

nicolewhite/RNeo4j documentation built on May 23, 2019, 5:09 p.m.