mirror of
https://github.com/planetmint/planetmint.git
synced 2025-03-30 15:08:31 +00:00
Merge branch 'planetmint:main' into main
This commit is contained in:
Lorenz Herzberger
GitHub
commit
6772a583b1
10
README.md
10
README.md
@ -18,13 +18,11 @@ so show the latest GitHub release instead.
|
||||
|
||||
# Planetmint Server
|
||||
|
||||
Planetmint is the blockchain database. This repository is for _BigchainDB Server_.
|
||||
Planetmint is the blockchain database. This repository is for _Planetmint Server_.
|
||||
|
||||
## The Basics
|
||||
|
||||
* [Try the Quickstart](https://docs.planetmint.com/projects/server/en/latest/quickstart.html)
|
||||
* [Read the Planetmint 2.0 whitepaper](https://www.planetmint.com/whitepaper/)
|
||||
* [Check out the _Hitchiker's Guide to BigchainDB_](https://www.planetmint.com/developers/guide/)
|
||||
* [Try the Quickstart](https://docs.planetmint.io/en/latest/introduction/index.html#quickstart)
|
||||
|
||||
## Run and Test Planetmint Server from the `master` Branch
|
||||
|
||||
@ -55,7 +53,7 @@ To view all commands available, run `make`.
|
||||
|
||||
## Links for Everyone
|
||||
|
||||
* [Planetmint.com](https://www.planetmint.com/) - the main Planetmint website, including newsletter signup
|
||||
* [Planetmint.io](https://www.planetmint.io/) - the main Planetmint website, including newsletter signup
|
||||
* [Roadmap](https://github.com/planetmint/org/blob/master/ROADMAP.md)
|
||||
* [Blog](https://medium.com/the-planetmint-blog)
|
||||
* [Twitter](https://twitter.com/Planetmint)
|
||||
@ -73,5 +71,3 @@ To view all commands available, run `make`.
|
||||
## Legal
|
||||
|
||||
* [Licenses](LICENSES.md) - open source & open content
|
||||
* [Imprint](https://www.planetmint.com/imprint/)
|
||||
* [Contact Us](https://www.planetmint.com/contact/)
|
||||
|
||||
@ -12,7 +12,7 @@ Know What You Want to Write Code to Do
|
||||
|
||||
Do you want to write code to resolve an open issue (bug)? Which one?
|
||||
|
||||
Do you want to implement a Planetmint Enhancement Proposal (PEP)? Which one?
|
||||
Do you want to implement a Planetmint Refinement Proposal (PRP)? Which one?
|
||||
|
||||
You should know why you want to write code before you go any farther.
|
||||
|
||||
@ -21,7 +21,7 @@ Refresh Yourself about the C4 Process
|
||||
-------------------------------------
|
||||
|
||||
C4 is the Collective Code Construction Contract. It's quite short:
|
||||
`re-reading it will only take a few minutes <https://github.com/planetmint/BEPs/tree/master/1>`_.
|
||||
`re-reading it will only take a few minutes <https://github.com/bigchaindb/BEPs/tree/master/1>`_.
|
||||
|
||||
|
||||
Set Up Your Local Machine. Here's How.
|
||||
@ -69,7 +69,7 @@ Set Up Your Local Machine. Here's How.
|
||||
Before You Start Writing Code
|
||||
-----------------------------
|
||||
|
||||
Read `BEP-24 <https://github.com/planetmint/BEPs/tree/master/24>`_
|
||||
Read `BEP-24 <https://github.com/bigchaindb/BEPs/tree/master/24>`_
|
||||
so you know what to do to ensure that your changes (i.e. your future pull request) can be merged.
|
||||
It's easy and will save you some hassle later on.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ It includes several sub-projects.
|
||||
- `Planetmint Java Driver <https://github.com/planetmint/java-bigchaindb-driver>`_
|
||||
- `cryptoconditions <https://github.com/planetmint/cryptoconditions>`_ (a Python package by us)
|
||||
- `py-abci <https://github.com/davebryson/py-abci>`_ (a Python package we use)
|
||||
- `Planetmint Enhancement Proposals (PEPs) <https://github.com/planetmint/PEPs>`_
|
||||
- `Planetmint Refinement Proposals (PRPs) <https://github.com/planetmint/PRPs>`_
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
@ -27,17 +27,17 @@ People ask questions about Planetmint in the following places:
|
||||
|
||||
Feel free to hang out and answer some questions. People will be thankful.
|
||||
|
||||
# Write a Planetmint Enhancement Proposal (PEP)
|
||||
# Write a Planetmint Refinement Proposal (PRP)
|
||||
|
||||
If you have an idea for a new feature or enhancement, and you want some feedback before you write a full Planetmint Enhancement Proposal (PEP), then feel free to:
|
||||
If you have an idea for a new feature or enhancement, and you want some feedback before you write a full Planetmint Refinement Proposal (PRP), then feel free to:
|
||||
- ask in the [planetmint/community Gitter chat room](https://gitter.im/planetmint/planetmint) or
|
||||
- [open a new issue in the planetmint/PEPs repo](https://github.com/planetmint/PEPs/issues/new) and give it the label **PEP idea**.
|
||||
- [open a new issue in the planetmint/PRPs repo](https://github.com/planetmint/PRPs/issues/new) and give it the label **PRP idea**.
|
||||
|
||||
If you want to discuss an existing PEP, then [open a new issue in the planetmint/PEPs repo](https://github.com/planetmint/BEPs/issues/new) and give it the label **discuss existing PEP**.
|
||||
If you want to discuss an existing PRP, then [open a new issue in the planetmint/PRPs repo](https://github.com/planetmint/PRPs/issues/new) and give it the label **discuss existing PRP**.
|
||||
|
||||
## Steps to Write a New PEP
|
||||
## Steps to Write a New PRP
|
||||
|
||||
1. Look at the structure of existing PEPs in the [planetmint/PEPs repo](https://github.com/planetmint/PEPs). Note the section headings. [PEP-2](https://github.com/planetmint/PEPs/tree/master/2) (our variant of the consensus-oriented specification system [COSS]) says more about the expected structure and process.
|
||||
1. Write a first draft of your PEP. It doesn't have to be long or perfect.
|
||||
1. Push your BEP draft to the [planetmint/PEPs repo](https://github.com/planetmint/PEPs) and make a pull request. [PEP-1](https://github.com/planetmint/PEPs/tree/master/1) (our variant of C4) outlines the process we use to handle all pull requests. In particular, we try to merge all pull requests quickly.
|
||||
1. Your PEP can be revised by pushing more pull requests.
|
||||
1. Look at the structure of existing PRPs in the [planetmint/PRPs repo](https://github.com/planetmint/PRPs). Note the section headings. [PRP-2](https://github.com/planetmint/PRPs/tree/master/2) (our variant of the consensus-oriented specification system [COSS]) says more about the expected structure and process.
|
||||
1. Write a first draft of your PRP. It doesn't have to be long or perfect.
|
||||
1. Push your BEP draft to the [planetmint/PRPs repo](https://github.com/planetmint/PRPs) and make a pull request. [PRP-1](https://github.com/planetmint/PRPs/tree/master/1) (our variant of C4) outlines the process we use to handle all pull requests. In particular, we try to merge all pull requests quickly.
|
||||
1. Your PRP can be revised by pushing more pull requests.
|
||||
@ -7,7 +7,7 @@
|
||||
Planetmint
|
||||
==========
|
||||
|
||||
Meet Planetmint. The blockchain database.
|
||||
Meet Planetmint. The metadata blockchain.
|
||||
|
||||
It has some database characteristics and some blockchain `properties <properties.html>`_,
|
||||
including decentralization, immutability and native support for assets.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user