|
| 1 | += Contributing to the Neo4j Ecosystem |
| 2 | +:sectanchors: |
| 3 | + |
| 4 | +At http://neo4j.com/[Neo4j], we develop our software in the open at |
| 5 | +GitHub. This provides transparency for you, our users, and allows you to |
| 6 | +fork the software to make your own additions and enhancements. We also |
| 7 | +provide areas specifically for community contributions, in particular |
| 8 | +the https://github.com/neo4j-contrib[neo4j-contrib] space. |
| 9 | + |
| 10 | +There's an active https://community.neo4j.com/[Neo4j Online Community] |
| 11 | +where we work directly with the community. If you're not already a |
| 12 | +member, sign up! |
| 13 | + |
| 14 | +We love our community and wouldn't be where we are without you. |
| 15 | + |
| 16 | +== Need to raise an issue? |
| 17 | + |
| 18 | +Where you raise an issue depends largely on the nature of the problem. |
| 19 | + |
| 20 | +Firstly, if you are an Enterprise customer, you might want to head over |
| 21 | +to our http://support.neo4j.com/[Customer Support Portal]. |
| 22 | + |
| 23 | +There are plenty of public channels available too, though. If you simply |
| 24 | +want to get started or have a question on how to use a particular |
| 25 | +feature, ask a question in https://community.neo4j.com/[Neo4j Online |
| 26 | +Community]. If you think you might have hit a bug in our software (it |
| 27 | +happens occasionally!) or you have specific feature request then use the |
| 28 | +issue feature on the relevant GitHub repository. Check first though as |
| 29 | +someone else may have already raised something similar. |
| 30 | + |
| 31 | +http://stackoverflow.com/questions/tagged/neo4j[StackOverflow] also |
| 32 | +hosts a ton of questions and might already have a discussion around your |
| 33 | +problem. Make sure you have a look there too. |
| 34 | + |
| 35 | +Include as much information as you can in any request you make: |
| 36 | + |
| 37 | +* Which versions of our products are you using? |
| 38 | +* Which language (and which version of that language) are you developing |
| 39 | +with? |
| 40 | +* What operating system are you on? |
| 41 | +* Are you working with a cluster or on a single machine? |
| 42 | +* What code are you running? |
| 43 | +* What errors are you seeing? |
| 44 | +* What solutions have you tried already? |
| 45 | + |
| 46 | +=== Want to contribute? |
| 47 | + |
| 48 | +If you want to contribute a pull request, we have a little bit of |
| 49 | +process you'll need to follow: |
| 50 | + |
| 51 | +* Do all your work in a personal fork of the original repository |
| 52 | +* https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request[Rebase], |
| 53 | +don't merge (we prefer to keep our history clean) |
| 54 | +* Create a branch (with a useful name) for your contribution |
| 55 | +* Make sure you're familiar with the appropriate coding style (this |
| 56 | +varies by language so ask if you're in doubt) |
| 57 | +* Include unit tests if appropriate (obviously not necessary for |
| 58 | +documentation changes) |
| 59 | +* Take a moment to read and sign our http://neo4j.com/developer/cla[CLA] |
| 60 | + |
| 61 | +We can't guarantee that we'll accept pull requests and may ask you to |
| 62 | +make some changes before they go in. Occasionally, we might also have |
| 63 | +logistical, commercial, or legal reasons why we can't accept your work |
| 64 | +but we'll try to find an alternative way for you to contribute in that |
| 65 | +case. Remember that many community members have become regular |
| 66 | +contributors and some are now even Neo employees! |
| 67 | + |
| 68 | +== Got an idea for a new project? |
| 69 | + |
| 70 | +If you have an idea for a new tool or library, start by talking to other |
| 71 | +people in the community. Chances are that someone has a similar idea or |
| 72 | +may have already started working on it. The best software comes from |
| 73 | +getting like minds together to solve a problem. And we'll do our best to |
| 74 | +help you promote and co-ordinate your Neo ecosystem projects. |
| 75 | + |
| 76 | +== Further reading |
| 77 | + |
| 78 | +If you want to find out more about how you can contribute, head over to |
| 79 | +our website for http://neo4j.com/developer/contributing-code/[more |
| 80 | +information]. |
0 commit comments