Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

Write CONTRIBUTING.md that would have helped me #250

Merged

Conversation

roschaefer
Copy link
Contributor

I like that @johnymontana has closed my pull request here:
#243

I don't find the standard CONTRIBUTING guidelines very helpful either.
The only thing that I like to re-use is a hint how to join the neo4j
community on Slack. I guess that would be the best option for new
contributors to get some guidance.

So in this commit I tried to document issues and my workarounds that I
discovered already. I hope other people find this useful.

close #248

I like that @johnymontana has closed my pull request here:
neo4j-graphql#243

I don't find the standard CONTRIBUTING guidelines very helpful either.
The only thing that I like to re-use is a hint how to join the neo4j
community on Slack. I guess that would be the best option for new
contributors to get some guidance.

So in this commit I tried to document issues and my workarounds that I
discovered already. I hope other people find this useful.
@codecov-io
Copy link

codecov-io commented May 21, 2019

Codecov Report

Merging #250 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #250   +/-   ##
=======================================
  Coverage   94.47%   94.47%           
=======================================
  Files           4        4           
  Lines         326      326           
=======================================
  Hits          308      308           
  Misses         18       18

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b44e18...31fa3d4. Read the comment docs.

following requirements:

- A local Neo4J instance with username `neo4j` and password `letmein`
- Your Neo4J instance runs on [this database](https://s3.amazonaws.com/neo4j-sandbox-usecase-datastores/v3_5/recommendations.db.zip)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johnymontana thank you for providing the file. Could you upload a dump of your database to s3.amazonaws.com..?

neo4j-admin dump --to=./recommendations-db
# upload recommendations-db to amazon aws

We could improve the documentation here and use neo4j-admin load ....

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By now I would prefer to check the file into version control. Opinions?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer not to check the datastore into git. Let's plan for a long term goal of refactoring the tests to use Cypher script fixtures rather than loading the datastore.

In the meantime a .dump version of the datastore is available here: https://s3-us-west-2.amazonaws.com/neo4j-datasets-public/recommendations.dump

@cmartin81
Copy link
Contributor

cmartin81 commented Jul 5, 2019

Thanks for the guide :)
It helped med with the issue running 2 instances of graphql

@johnymontana johnymontana merged commit a3376c4 into neo4j-graphql:master Jul 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add contributing guidelines
4 participants