Skip to content

Commit

Permalink
tune how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
AthrunArthur committed Sep 25, 2018
1 parent 80932b6 commit b081141
Showing 1 changed file with 37 additions and 14 deletions.
51 changes: 37 additions & 14 deletions docs/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
# 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!
> *Your contribution matters!* Nebulas aims for a continuously improving ecosystem, which means we need everyone's efforts from community. We here call for your contribution. It can be not only programming, bug reporting and tranlating, but also can be talking with others or answering others' questions with your favourite IM tools or email.
## 1. Code & Documentation
### 1.1. Mainnet Development
<!--Nebulas mainnet development is the most important and challenging portion of Nebulas technical development. -->
Besides programming, mainnet development also needs efforts to tackle the most
chanllenging problems in the whole blockchain industry. For example, we need
design manipulation-resistant mechanisms for blockchain, formally verify
new consensus algorithm, improve security of Nebulas mainnet, apply new
crypto algorithm to Nebulas, and etc..

We are so excited to devote ourselves to blockchain and seeing how blockchain
makes people's life better. And we want to share this exciting experience to
the whole community. Thus, we call for each developers!

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.
### 1.2. Bug Reporting
We always value bug reporting!

If you find a bug, please report it to the Nebulas community. 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.

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.
<!--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.
Expand All @@ -23,26 +36,29 @@ Mainnet bug list: [https://lists.nebulas.io/cgi-bin/mailman/listinfo/mainnet-bug

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
### 1.3. Translation
Translation is important to spread Nebulas to the whole world!
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
### 1.4. 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

### 1.5. 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)
## 2. User Groups
Communication is the key for building community. People need talk with each
other in the purpose of sharing their ideas or their thinkings of Nebulas.
Nebulas utilizes several platforms to connect our global community. Please refer 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.

Expand All @@ -52,9 +68,16 @@ 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
## 3. Bounties
> *Note:* this is temporary since we believe that bounties are helpful for the
> beginning of a community, but also can be harmful for a long-term
> perspective.
We, Nebulas team, happily introduce several bounties to reward early
contributors.
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

## 4. 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.

0 comments on commit b081141

Please sign in to comment.