1
0
mirror of https://github.com/bigchaindb/js-bigchaindb-driver.git synced 2024-11-22 01:36:56 +01:00

license, authors, etc

This commit is contained in:
diminator 2017-05-09 20:23:11 +02:00
parent 9d0f4f5f72
commit 9d250f7f9a
No known key found for this signature in database
GPG Key ID: C3D8590E6D0D439A
5 changed files with 150 additions and 0 deletions

13
AUTHORS.rst Normal file
View File

@ -0,0 +1,13 @@
=======
Credits
=======
Development Lead
----------------
* BigchainDB <dev@bigchaindb.com>
Contributors
------------
Inspired by @Sohkai. Why not be the second?

7
CHANGELOG.rst Executable file
View File

@ -0,0 +1,7 @@
Changelog
=========
0.0.1a1 (2017-05-09)
--------------------
* Planning release on npm.

106
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,106 @@
.. 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

15
HACKING.rst Normal file
View File

@ -0,0 +1,15 @@
Installing latest master with pip
---------------------------------
In order to work with the latest BigchainDB (server) master branch:
.. code-block:: bash
$ pip install --process-dependency-links git+https://github.com/bigchaindb/bigchaindb-driver.git
Point to some BigchainDB node, which is running BigchainDB server ``master``:
.. code-block:: python
from bigchaindb_driver import BigchainDB
bdb = BigchainDB('http://here.be.dragons:9984')

9
LICENSES.md Executable file
View File

@ -0,0 +1,9 @@
# Code Licenses
All code in _this_ repository (including short code snippets embedded in the official BigchainDB _documentation_) is licensed under the Apache Software License 2.0, the full text of which can be found at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
For the licenses on all other BigchainDB-related code, see the license file in the associated repository.
# Documentation Licenses
The official BigchainDB documentation, _except for the short code snippets embedded within it_, is licensed under a Creative Commons Attribution-ShareAlike 4.0 International license, the full text of which can be found at [http://creativecommons.org/licenses/by-sa/4.0/legalcode](http://creativecommons.org/licenses/by-sa/4.0/legalcode).