|
| 1 | += Contributing to Neo4j |
| 2 | +:page-layout: center-align |
| 3 | +:author: Neo4j |
| 4 | +:category: development |
| 5 | +:tags: community, contributions, share |
| 6 | + |
| 7 | +[#neo4j-contribute] |
| 8 | +Looking for a place to contribute to the Neo4j ecosystem? |
| 9 | +This is a great place to start. |
| 10 | +Here you will find guides from Neo4j’s community of contributors. |
| 11 | + |
| 12 | +[#finding-help] |
| 13 | +== Help Others in the Community |
| 14 | + |
| 15 | +Want to help others? |
| 16 | + |
| 17 | +There are a number of great resources the Neo4j community uses to get quick help from graph database experts. |
| 18 | +Don't hesitate to ask when you’re stuck and looking for help. Also, if you're familiar with a particular topic area, please jump in and lend a hand for your fellow graphistas. |
| 19 | + |
| 20 | +The primary home for Neo4j community discussion is our https://community.neo4j.com[Neo4j Forum^]. |
| 21 | + |
| 22 | +We also have some other places the community asks questions. |
| 23 | + |
| 24 | +* http://stackoverflow.com/questions/tagged/neo4j[Neo4j on StackOverflow^] |
| 25 | +* http://twitter.com/neo4j[Social: Neo4j on Twitter^] |
| 26 | +* https://discord.gg/neo4j[Discord Chat^] |
| 27 | +* http://github.com/neo4j/neo4j/issues[Raise Issues: GitHub Issues^] |
| 28 | +
|
| 29 | +[#ask-question-tips] |
| 30 | +== Tips for Asking Good Questions |
| 31 | + |
| 32 | +If you have technical questions, we would love to help you find the answers to them! Please help us help you by following the guidelines below. |
| 33 | + |
| 34 | +*Write a title that summarizes the specific problem* + |
| 35 | +The title may be the first and the last thing that potential viewers see of your post. |
| 36 | +Make it count. Make it describe the problem, not your current state of mind. |
| 37 | +ALL CAPS and lots of question and exclamation marks are an indication that you wear your underwear on your head ??? not that you have an urgent problem !!! |
| 38 | + |
| 39 | +*Choose the correct "category" and add the relevant "tags"* + |
| 40 | +Both of these serve to narrow down the problem area. |
| 41 | +A database creation error on the "Neo4j Desktop" is quite possible, it is almost impossible if installed with a Yum package. |
| 42 | +For installation questions specifying the OS is definitely useful. And so on. |
| 43 | + |
| 44 | +*Explain First* + |
| 45 | +What do you want to accomplish? What is the problem? |
| 46 | +What have you tried (you have tried something, right...right?)? |
| 47 | +Can you reproduce the situation? Which steps need to be followed to get there? |
| 48 | + |
| 49 | +*Code Second* + |
| 50 | +For some weird reason, Verdana 12pt does horrible things to code. |
| 51 | +There are a ton of ways to add readable code in your posts, the easiest is to select it and use the </> preformatted text icon. |
| 52 | +Reading hundreds of lines of code and Cypher-queries is the favorite hobby of most of the visitors of the forum. |
| 53 | +Just in case it is one of the others that is trying to help you, provide the code that demonstrates the issue and no more. |
| 54 | + |
| 55 | +*Proofread* + |
| 56 | +Are you ready to press "Create"? Take a deep breath. Exhale. |
| 57 | +Go once more over what you've just written. Does it look like the kind of question you could answer? |
| 58 | + |
| 59 | +*I'm not sure my English is good enough...can I get help?* + |
| 60 | +Just do the best you can! While technical questions should be in English, there are Local Groups on the forum. |
| 61 | +Not only are those good for finding out about local activities, but there might be somebody else there that knows (for example) South-West England English and can help you translate it into six o'clock news English! |
| 62 | + |
| 63 | +*Be Patient - Be Friendly - Be Polite - Help someone else in turn* + |
| 64 | +Somebody is going to spend some of the single most valuable resources for a human on your question. Time. |
| 65 | +Giving an indication that you understand the value of that is the least you can do. |
| 66 | + |
| 67 | +[#speaking] |
| 68 | +== Sharing your Love of Graphs |
| 69 | + |
| 70 | +No matter where you live in the world, there are plenty of ways to share your love of graphs |
| 71 | +and help others understand the importance of relationships. |
| 72 | + |
| 73 | +With thousands of technology and business *conferences* occuring every year around the world, |
| 74 | +you can present to your peers and become a recognized expert in your field. Neo4j, via the |
| 75 | +link:/speaker-program/[*Neo4j Speaker Program*], can also help and reimburse |
| 76 | +travel expenses for community members speaking at many of the top conferences. |
| 77 | + |
| 78 | +There are also hundreds of face-to-face https://www.meetup.com/topics/neo4j/[*Neo4j meetup groups*] in communities |
| 79 | +around the world. Many of these meetup groups regularly look for speakers to share their stories. |
| 80 | + |
| 81 | +The https://www.meetup.com/Neo4j-Online-Meetup/[*Neo4j Online Meetup*] is a way for you to meet the global community online and share your story. |
| 82 | + |
| 83 | +We select talks for the Online Meetup and stories for our link:/tag/twin4j/[*Developer Newsletter*] from https://community.neo4j.com/[*Neo4j Community Forum*]. To submit your story, post it in the `Projects & Collaboration` (if including a link to github or website) or `Community Content & Blogs` (if linking to a blog post, |
| 84 | +slideshow, video, or article) categories. |
| 85 | + |
| 86 | +[#contributing] |
| 87 | +== Other Ways to Contribute |
| 88 | + |
| 89 | +The Neo4j project is an open source effort to bring fast, complex data storage and processing to life. |
| 90 | +Every form of help is highly appreciated by the community. |
| 91 | +Note that you can contribute to Neo4j also by providing documentation or giving feedback on the current documentation. |
| 92 | +Basically, in all the places where you can get help, there is also room for contributions. |
| 93 | + |
| 94 | +* link:/developer/contributing-code/[Contributing Code^] |
| 95 | +* link:/developer/cla/[Contributors License Agreement^] |
| 96 | +* GitHub http://github.com/neo4j/neo4j/issues[Issues^] and http://github.com/neo4j/neo4j/pulls[Pull Requests^] |
| 97 | +* See the https://github.com/neo4j/neo4j/graphs/contributors[list of contributors^] |
| 98 | +
|
| 99 | +[#develop-neo4j] |
| 100 | +== Tools for Developing Neo4j |
| 101 | + |
| 102 | +We are happy users of the following tools that we use daily to develop Neo4j. |
| 103 | + |
| 104 | +* IDE: https://www.jetbrains.com/idea/[IntelliJ Idea by JetBrains^] - *Thank you so much for the https://www.jetbrains.com/idea/buy/choose_edition.jsp?license=OPEN_SOURCE[OSS license^]!* and Eclipse |
| 105 | +* Build System: https://www.jetbrains.com/teamcity/[TeamCity by JetBrains^] - *Thank you so much for the https://www.jetbrains.com/teamcity/buy/choose_edition.jsp?license=OPEN_SOURCE[OSS license^]!* |
| 106 | +* Profiler: Yourkit, VisualVM, jvmtop, Java Mission Control, Flight Recorder |
| 107 | +* Version Control: Git & http://github.com/neo4j[GitHub^] |
| 108 | +* Issue Management: Trello and http://github.com/neo4j/neo4j/issues[GitHub issues^] |
| 109 | +* Team Communication: Neo4j Community Site, Discord, Google Hangouts, and Zoom |
| 110 | +* Pair Programming: Team Viewer, join.me |
| 111 | +* Documents: Google Docs |
| 112 | +* Manual, GraphGists, Presentations: http://asciidoctor.org[AsciiDoctor^] |
| 113 | +* Programming Language: Java, Build-Tool - Maven |
| 114 | +* Libraries - JVM: Scala, Parboiled, Google Collections, JMH, Jetty, Jersey, Jackson, Apache Commons, JUnit |
| 115 | +* Libs & Tools: Javascript: D3.js, Angular.js, Grunt, Bower |
| 116 | +
|
| 117 | +[#integration-dev] |
| 118 | +== Tools, Libraries, and Drivers |
| 119 | + |
| 120 | +Neo4j is supported by a rich ecosystem of libraries, tools, drivers and guides provided by partners, users and community contributors. |
| 121 | +We want to give an overview about what is available and link to the original sources. |
| 122 | +We try to focus on the freely available solutions here and provide links to commercial options where appropriate. |
| 123 | + |
| 124 | +Read more about it in our link:/developer/integration/[Integrations section]. |
0 commit comments