Skip to content

Commit

Permalink
add how-to-contribute.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xujianxin committed Sep 14, 2018
1 parent 8d69371 commit a271291
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 3 deletions.
60 changes: 60 additions & 0 deletions docs/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# How to Contribute
## a. Code & Documentation
### i. Mainnet Development
Nebulas mainnet development is the most important portion of Nebulas technical development. We hope that more community members and developers will participate in our mainnet growth and development. In addition, we will reward the community members who contributes an abundance to mainnet development via our bounty program. Please stay tuned!

Learn more:

Our github:[https://github.com/nebulasio/go-nebulas](https://github.com/nebulasio/go-nebulas)

Our Roadmap: [https://nebulas.io/roadmap.html](https://nebulas.io/roadmap.html) (Stay tuned)

### ii. Bug Reporting
if you find a bug, please report it to the Nebulas team. Bugs may be found on Nebulas testnet, mainnet, nebPay, neb.js, web wallet, as well as other tools and documentation. We will follow OWASP Risk Assessment System to calculate the corresponding bounty/reward based on the risk degree of the bug. Bugs with high risk will be rewarded 150 NAS+, medium risk 50 NAS+ and low risk 10 NAS+. No capped.

Every time we launch a new function, we will first deploy it on our testnet. Currently, we have launched our first new function on the Nebulas testnet and everyone is welcome to try it, report any found bugs and receive the corresponding reward. The first of many new functions in public beta on the testnet is the inter-contract function.
If you have suggestions on how to fix bugs or help us make improvements, please do not hesitate to let us know. You can also participate in the development and directly protect the on chain assets. Together let’s make Nebulas even more safe, secure and robust.

To submit bugs and related information, please post the information in the related Nebulas mail groups. When submitting reports, please be careful and pay attention in the mail group to prevent bugs from being exploited or duplicate submissions. We welcome you to follow the mail group and join the discussion.

Mail group list: [https://lists.nebulas.io/cgi-bin/mailman/listinfo](https://lists.nebulas.io/cgi-bin/mailman/listinfo)

Mainnet bug list: [https://lists.nebulas.io/cgi-bin/mailman/listinfo/mainnet-bugs](https://lists.nebulas.io/cgi-bin/mailman/listinfo/mainnet-bugs)

Testnet bug list: [https://lists.nebulas.io/cgi-bin/mailman/listinfo/testnet-bugs](https://lists.nebulas.io/cgi-bin/mailman/listinfo/testnet-bugs)

### iii. Translation
We welcome community members from around the world to participate in the translation of Nebulas documentation. You can translate everything from the wiki, including mainnet technical development documents, DApp FAQ, official documents about Nebulas whitepaper and Yellow Paper, Nebulas design principle introduction and more. Your contribution significantly helps numerous Nebulas developers and community members.
Please note that some documents will require a professional background in Math, Computer Science, Cryptography or other specialties.

### iv. Documentation Writing
Developers in the Nebulas community require documentation to help them understand and use the various functions of Nebulas. The community is welcomed and encouraged to write technical introductions and FAQs.
In addition, Nebulas community members also require easy-to-understand introduction and user guide of various ecosystem tools.

Your contribution will benefit all community developers and members, and may also be translated into multi-languages to benefit even more community members.

### v. Wiki UI Design
We welcome UI developers to optimize our wiki page and make it more user friendly and easier to read.

Download our wiki > (design template)

Download LOGO material >
If you have any question or comments, please do not hesitate to post on our github.

## b. User Groups
Nebulas utilizes several platforms to connect our global community. Please refers to the “Community” link on official website for more information: [https://nebulas.io/community.html](https://nebulas.io/community.html)

Discord: Available for all community members. You can subscribe to Nebulas News as well as participate in group discussion. Discord is many users first choice.

Mailing lists: Discussion group for core development and bug reporting. We welcome developers to subscribe.

Forum: Reddit/r/nebulas (for all), Reddit/r/nasdev(for developers)
Communication: Slack(for developers),Telegram(for non-developers)
We welcome community developers to create an IRC(Internet Relay Chat) for better communication with developers.

## c. Bounties
Nebulas Bounty rewards includes:
Developer Bounty:please refers to the Developer Bounty List
Wiki Bounty: Based on the contribution, we will give different sized rewards to the users who greatly contribute to the Nebulas Wiki based on Github activity. For example, the reward for translating Nebulas Yellow Paper will be 200 NAS. The deadline of first evaluation is Dec. 31, 2018. The specific reward amount and number of recipients will be public.Based on the participation, this will help adjust the reward size in the future.
## d. Donation
We welcome donations from the community for developing Nebulas. Both NAS and ETH are accepted. We also welcome community members to support us in material terms. For example, the donation of meetup locations, local guide,photography, etc.. We can also make your contribution known to the community if you like. If you are an enthusiastic community member and are willing to contribute to our community, please send an email to contact@nebulas.io for more details.
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to nebulas's documentation!
Nebulas Wiki
========================================

.. toctree::
:maxdepth: 2
:titlesonly:
:caption: Table of Contents:

tutorials-1.md
overview.md
how-to-contribute.md
whats-nebulas/README.rst
go-nebulas/README.rst
dapp-development/README.rst
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md → docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to Nebulas Guide
# Overview

{% hint style="info" %}
This Guide is in progress. Welcome to edit it and help more users and developers in the Nebulas ecosystem.
Expand Down

0 comments on commit a271291

Please sign in to comment.