Add CONTRIBUTING based on drivers repo.
This commit is contained in:
80
CONTRIBUTING.adoc
Normal file
80
CONTRIBUTING.adoc
Normal file
@@ -0,0 +1,80 @@
|
||||
= Contributing to the Neo4j Ecosystem
|
||||
:sectanchors:
|
||||
|
||||
At http://neo4j.com/[Neo4j], we develop our software in the open at
|
||||
GitHub. This provides transparency for you, our users, and allows you to
|
||||
fork the software to make your own additions and enhancements. We also
|
||||
provide areas specifically for community contributions, in particular
|
||||
the https://github.com/neo4j-contrib[neo4j-contrib] space.
|
||||
|
||||
There's an active https://community.neo4j.com/[Neo4j Online Community]
|
||||
where we work directly with the community. If you're not already a
|
||||
member, sign up!
|
||||
|
||||
We love our community and wouldn't be where we are without you.
|
||||
|
||||
== Need to raise an issue?
|
||||
|
||||
Where you raise an issue depends largely on the nature of the problem.
|
||||
|
||||
Firstly, if you are an Enterprise customer, you might want to head over
|
||||
to our http://support.neo4j.com/[Customer Support Portal].
|
||||
|
||||
There are plenty of public channels available too, though. If you simply
|
||||
want to get started or have a question on how to use a particular
|
||||
feature, ask a question in https://community.neo4j.com/[Neo4j Online
|
||||
Community]. If you think you might have hit a bug in our software (it
|
||||
happens occasionally!) or you have specific feature request then use the
|
||||
issue feature on the relevant GitHub repository. Check first though as
|
||||
someone else may have already raised something similar.
|
||||
|
||||
http://stackoverflow.com/questions/tagged/neo4j[StackOverflow] also
|
||||
hosts a ton of questions and might already have a discussion around your
|
||||
problem. Make sure you have a look there too.
|
||||
|
||||
Include as much information as you can in any request you make:
|
||||
|
||||
* Which versions of our products are you using?
|
||||
* Which language (and which version of that language) are you developing
|
||||
with?
|
||||
* What operating system are you on?
|
||||
* Are you working with a cluster or on a single machine?
|
||||
* What code are you running?
|
||||
* What errors are you seeing?
|
||||
* What solutions have you tried already?
|
||||
|
||||
=== Want to contribute?
|
||||
|
||||
If you want to contribute a pull request, we have a little bit of
|
||||
process you'll need to follow:
|
||||
|
||||
* Do all your work in a personal fork of the original repository
|
||||
* https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request[Rebase],
|
||||
don't merge (we prefer to keep our history clean)
|
||||
* Create a branch (with a useful name) for your contribution
|
||||
* Make sure you're familiar with the appropriate coding style (this
|
||||
varies by language so ask if you're in doubt)
|
||||
* Include unit tests if appropriate (obviously not necessary for
|
||||
documentation changes)
|
||||
* Take a moment to read and sign our http://neo4j.com/developer/cla[CLA]
|
||||
|
||||
We can't guarantee that we'll accept pull requests and may ask you to
|
||||
make some changes before they go in. Occasionally, we might also have
|
||||
logistical, commercial, or legal reasons why we can't accept your work
|
||||
but we'll try to find an alternative way for you to contribute in that
|
||||
case. Remember that many community members have become regular
|
||||
contributors and some are now even Neo employees!
|
||||
|
||||
== Got an idea for a new project?
|
||||
|
||||
If you have an idea for a new tool or library, start by talking to other
|
||||
people in the community. Chances are that someone has a similar idea or
|
||||
may have already started working on it. The best software comes from
|
||||
getting like minds together to solve a problem. And we'll do our best to
|
||||
help you promote and co-ordinate your Neo ecosystem projects.
|
||||
|
||||
== Further reading
|
||||
|
||||
If you want to find out more about how you can contribute, head over to
|
||||
our website for http://neo4j.com/developer/contributing-code/[more
|
||||
information].
|
||||
Reference in New Issue
Block a user