Skip to content

Commit

Permalink
Merge pull request #5 from CrisBRM/patch-1
Browse files Browse the repository at this point in the history
Revamps how to contribute
  • Loading branch information
smalloranges committed Sep 29, 2018
2 parents 93e98ef + 51530e6 commit a28c568
Showing 1 changed file with 33 additions and 35 deletions.
68 changes: 33 additions & 35 deletions docs/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# How to Contribute
> *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.
> Nebulas aims for a continuously improving ecosystem, which means we need help from the community. We need your contributions! It is not limited exclusively to programming, but also bug reports and translations, spreading the tenets of Nebulas, answering questions, and so on.
## 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..
Besides programming, mainnet development is still ongoing and needs the help of the community to tackle challenging problems in the blockchain industry. For instance, we need to
design manipulation-resistant mechanisms for blockchain, formally verify the
new consensus algorithm, improve security of the Nebulas mainnet, apply new
crypto algorithms to Nebulas, etcetera.

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!
We are so excited to devote ourselves to blockchain and to see how blockchain
can improve people's lives. We want to share this exciting experience with
the whole community. Thus, we call upon developers!

Learn more:

Expand All @@ -23,14 +22,14 @@ Our github:[https://github.com/nebulasio/go-nebulas](https://github.com/nebula
Our Roadmap: [https://nebulas.io/roadmap.html](https://nebulas.io/roadmap.html) (Stay tuned)

### 1.2. Bug Reporting
We always value bug reporting!
We have always valued 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.
If you find a bug, please report it to the Nebulas community. Bugs may be found on the Nebulas testnet, mainnet, nebPay, neb.js, web wallet, as well as other tools and documentation. We will follow the 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.-->
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.
<!--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 bugs discovered 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 improve upon an affiliated project, please do not hesitate to let us know. You can also participate in the development and directly protect the onchain 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.
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 to the mail group in order to prevent bugs from being exploited or create duplicates. 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)

Expand All @@ -39,51 +38,50 @@ 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)

### 1.3. Translation
Translation is important to spread Nebulas to the whole world!
Translating 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.
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 documents, the DApp FAQ, official documents such as the Nebulas White Paper and Yellow Paper, the Nebulas design principle introduction document, and more. Your contribution will significantly help numerous Nebulas developers and community members.
Please note that some documents will require a professional background in Math, Computer Science, Cryptography, or other specialties.

### 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.
Developers in the Nebulas community require documentation to help them understand and use the various functions of Nebulas. The community is welcome and encouraged to write technical introductions and FAQs.
In addition, Nebulas community members will also benefit from easy-to-understand introductory guides and user guides on 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.
Your contribution will be of use to all community developers and members, and may also be translated into multiple languages to benefit an even larger amount of members.

### 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.
If you have any questions or comments, please do not hesitate to post on our github.

## 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.
Communication is key for building a vibrant community. People need to talk with each
other in order to share their ideas and thoughts on 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.
Discord: Available for all community members. You can subscribe to Nebulas News, as well as participate in group discussions. Discord is many users' first choice.

Mailing lists: Discussion group for core development and bug reporting. We welcome developers to subscribe.
Mailing lists: Discussion groups 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.
Communication: Slack(for developers), Telegram(for non-developers)
We welcome community developers to create an IRC (Internet Relay Chat) channel for better communication among developers.

## 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.
> *Note:* this is temporary since we believe that bounties are helpful only during the
> early stages of a community, but can also be harmful in the long-term
We, Nebulas team, happily introduce several bounties to reward early
We, the 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.
Nebulas Bounty rewards include:
Developer Bounty:please refer to the Developer Bounty List
Wiki Bounty: Based on the contribution, we will give different sized rewards to users who greatly contribute to the Nebulas Wiki, based on Github activity. For example, the reward for translating the Nebulas Yellow Paper will be 200 NAS. The deadline of the first evaluation is Dec. 31, 2018. The specific reward amount and number of recipients will be public. Depending on participation, the reward size will be adjusted in the future.

## 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.
We welcome donations to develop Nebulas from the community. Both NAS and ETH are accepted. We also welcome community members to support us in material terms. For example, the donation of meetup locations/spaces, local guides, photography, etcetera. We can also make your contribution known to the community if you would 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 a28c568

Please sign in to comment.