Lorenz Herzberger 65f238b81a
update documentation for pypi (#184)
* updated version number to 1.0.0

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

* added tarantool sharding section and zenroom contracts and policies

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

* update links on documentation, fixed PEP to PRP

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>

* removed missing links

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>
2022-07-07 11:37:28 +02:00

2.3 KiB

How to contribute?

Report a Bug

To report a bug, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions.

Write an Issue

To write an issue, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions.

Answer Questions

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 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 Refinement Proposal (PRP), then feel free to:

If you want to discuss an existing PRP, then open a new issue in the planetmint/PRPs repo and give it the label discuss existing PRP.

Steps to Write a New PRP

  1. Look at the structure of existing PRPs in the planetmint/PRPs repo. Note the section headings. PRP-2 (our variant of the consensus-oriented specification system [COSS]) says more about the expected structure and process.
  2. Write a first draft of your PRP. It doesn't have to be long or perfect.
  3. Push your BEP draft to the planetmint/PRPs repo and make a pull request. PRP-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.
  4. Your PRP can be revised by pushing more pull requests.