Skip to content

Commit

Permalink
tweak how-to-contribute.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Elizabeth Dieli authored and Elizabeth Dieli committed Jul 1, 2019
1 parent 315c7bd commit 0bd07b9
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions docs/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,26 @@
> 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.
Most of our projects and their corresponding bounties can be found [here](http://go.nebulas.io).

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

Learn more:

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

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

### 1.2. 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 the Nebulas testnet, mainnet, nebPay, neb.js, web wallet, as well as other tools and documentation. We will follow the [OWASP Risk Assessment System](https://www.owasp.org/index.php/OWASP_Risk_Rating_Methodology) to calculate the corresponding bounty/reward based on the risk degree of the bug. More TBA.
If you find a bug, please report it to the Nebulas community. You will be rewarded for it. Check [the Nebulas Bounty Program here](http://wiki.nebulas.io/en/latest/bounty-program.html) for more details.
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](https://www.owasp.org/index.php/OWASP_Risk_Rating_Methodology) to calculate the corresponding bounty/reward based on the risk degree of the bug. More TBA.

<!--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.
Expand All @@ -41,8 +39,8 @@ Testnet bug list: [lists.nebulas.io/cgi-bin/mailman/listinfo/testnet-bugs](https
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 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.
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 many academic papers, the Nebulas design principles introduction document, and more. Your contribution will significantly help numerous Nebulas developers and community members.
Please note that some documents will require an academic background in Math, Computer Science, Cryptography, and/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 welcome and encouraged to write technical introductions and FAQs.
Expand All @@ -53,20 +51,19 @@ Your contribution will be of use to all community developers and members, and ma
### 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 design template of Nebulas wiki >](https://drive.google.com/drive/folders/10ZWW1ygjnLa3VtjJ88fhv1jUai9SXNNz?usp=sharing)
[Download the design template of the Nebulas wiki >](https://drive.google.com/drive/folders/10ZWW1ygjnLa3VtjJ88fhv1jUai9SXNNz?usp=sharing)

[Download LOGO material >](https://nebulas.io/docs/NEBULAS-LOGO-SVG.zip)
[Download the logo >](https://nebulas.io/docs/NEBULAS-LOGO-SVG.zip)

If you have any questions 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 key for building a vibrant community. People need to talk with each
other in order to share their ideas and thoughts on 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 uses several platforms to connect our global community. Please refer to the [“Community”](https://nebulas.io/community.html) page on official website for more information.
Nebulas uses several platforms to connect with its global community. Please refer to the [“Community”](https://nebulas.io/community.html) page on the official website for more information.

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.
Discord: Available to 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 groups for core development and bug reporting. We welcome developers to subscribe.

Expand All @@ -78,8 +75,7 @@ Community developers are welcome to create an IRC (Internet Relay Chat) channel

## 3. Bounties

We, the Nebulas team, happily introduce several bounties to reward early contributors.
- [Nebulas Wiki Bounty Program](https://medium.com/nebulasio/nebulas-wiki-bounty-program-32048077e16c)
We, the Nebulas team, happily introduce several bounties to reward early contributors. You can check them out [here](http://wiki.nebulas.io/en/latest/bounty-program.html)

## 4. Donations
Donations to the Nebulas Foundation to further the development of Nebulas are greatly appreciated. Both NAS and ETH are accepted. We also welcome community members to support us in material terms. For instance, the donation of meetup locations/venues, 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, email [contact@nebulas.io](mailto:contact@nebulas.io) for more details.

0 comments on commit 0bd07b9

Please sign in to comment.