2018-08-10 12:49:26 +02:00
|
|
|
|
|
|
|
|
.. Copyright BigchainDB GmbH and BigchainDB contributors
|
|
|
|
|
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
|
|
|
|
Code is Apache-2.0 and docs are CC-BY-4.0
|
|
|
|
|
|
2017-05-09 20:23:11 +02:00
|
|
|
.. highlight:: shell
|
|
|
|
|
|
|
|
|
|
============
|
|
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
Contributions are welcome, and they are greatly appreciated! Every
|
|
|
|
|
little bit helps, and credit will always be given.
|
|
|
|
|
|
|
|
|
|
You can contribute in many ways:
|
|
|
|
|
|
|
|
|
|
Types of Contributions
|
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
Report Bugs
|
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Report bugs at https://github.com/bigchaindb/js-bigchaindb-driver/issues.
|
|
|
|
|
|
|
|
|
|
If you are reporting a bug, please include:
|
|
|
|
|
|
|
|
|
|
* Your operating system name and version.
|
|
|
|
|
* Any details about your local setup that might be helpful in troubleshooting.
|
|
|
|
|
* Detailed steps to reproduce the bug.
|
|
|
|
|
|
|
|
|
|
Fix Bugs
|
|
|
|
|
~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Look through the GitHub issues for bugs. Anything tagged with "bug"
|
|
|
|
|
and "help wanted" is open to whoever wants to implement it.
|
|
|
|
|
|
|
|
|
|
Implement Features
|
|
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Look through the GitHub issues for features. Anything tagged with "enhancement"
|
|
|
|
|
and "help wanted" is open to whoever wants to implement it.
|
|
|
|
|
|
|
|
|
|
Write Documentation
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
bigchaindb-driver could always use more documentation, whether as part of the
|
|
|
|
|
official bigchaindb-driver docs, in docstrings, or even on the web in blog posts,
|
|
|
|
|
articles, and such.
|
|
|
|
|
|
|
|
|
|
Submit Feedback
|
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The best way to send feedback is to file an issue at https://github.com/bigchaindb/js-bigchaindb-driver/issues.
|
|
|
|
|
|
|
|
|
|
If you are proposing a feature:
|
|
|
|
|
|
|
|
|
|
* Explain in detail how it would work.
|
|
|
|
|
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
|
|
|
* Remember that this is a volunteer-driven project, and that contributions
|
|
|
|
|
are welcome :)
|
|
|
|
|
|
|
|
|
|
Get Started!
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Ready to contribute? Here's how to set up `js-bigchaindb-driver`_ for local
|
|
|
|
|
development.
|
|
|
|
|
|
|
|
|
|
1. Fork the `js-bigchaindb-driver`_ repo on GitHub.
|
|
|
|
|
2. Clone your fork locally and enter into the project::
|
|
|
|
|
|
|
|
|
|
$ git clone git@github.com:your_name_here/js-bigchaindb-driver.git
|
|
|
|
|
$ cd js-bigchaindb-driver/
|
|
|
|
|
|
|
|
|
|
3. Create a branch for local development::
|
|
|
|
|
|
|
|
|
|
$ git checkout -b name-of-your-bugfix-or-feature
|
|
|
|
|
|
|
|
|
|
Now you can make your changes locally.
|
|
|
|
|
|
|
|
|
|
4. Write tests ;-)
|
|
|
|
|
|
|
|
|
|
5. Test!
|
|
|
|
|
|
|
|
|
|
6. Commit your changes and push your branch to GitHub::
|
|
|
|
|
|
|
|
|
|
$ git add .
|
|
|
|
|
$ git commit -m "Your detailed description of your changes."
|
|
|
|
|
$ git push origin name-of-your-bugfix-or-feature
|
|
|
|
|
|
|
|
|
|
7. Submit a pull request through the GitHub website.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Pull Request Guidelines
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
Before you submit a pull request, check that it meets these guidelines:
|
|
|
|
|
|
|
|
|
|
1. The pull request should include tests.
|
|
|
|
|
2. If the pull request adds functionality, the docs should be updated. Put
|
|
|
|
|
your new functionality into a function with a docstring, and add the
|
|
|
|
|
feature to the list in README.rst.
|
|
|
|
|
3. The pull request should work for JS and node. Travis or others would be an interesting
|
|
|
|
|
way for automate the tests...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Dependency on Bigchaindb
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
This version is compatible from BigchainDB server v0.10.1
|
|
|
|
|
|
|
|
|
|
.. _bigchaindb-driver: https://github.com/bigchaindb/js-bigchaindb-driver
|
