Nebula Graph Contributor Reward Plan
Nebula Graph is an open-source graph database project and we welcome contributions from the community to help users grow. Let's work together to make Nebula Graph a better graph database for the entire community.
- Steps to submit a pull request
- Credit Rules
- Definition of bug criticalness
- How to Redeem Your Credits
- Credit Change Log
There are two ways you can contribute, i.e. pull request and issue
-
ForkNebula Graph's repo on GitHub - Clone Nebula Graph's code to your own repo
- Make changes to the existing code or documentation, for example fixing a bug, commit a pull request for new features, add information to the docs, etc. When you're done updating the code or docs locally, commit the updates
- Go back to your own Nebula Graph repo and click the
New pull requestbutton. Add a description to this change in the title and if this pull request is to fix an existing issue, then attach the link to the issue in the body. - You will earn credits granted by Nebula Graph after successfully submitting a pull request. See Contributor Credit Rules for details.
New to GitHub and need a more detailed tutorial? Here's a step-by-step guide to show you how to become a GitHub contributor in five minutes.
- Please use the template below to raise an issue so that Nebula Graph staff can grade the issue as soon as they see it. We will grant credits to the issue raiser based on the level of the issue itself. See Issue Grade Rules for how we assign a level to each issue. See Credit Rules for the credits granted to each issue level.
**Please check the FAQ documentation before raising an issue**
Please check the [FAQ](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/1.overview/2.quick-start/2.FAQ.md) documentation and old issues before raising an issue in case someone has asked the same question that you are asking.
**Describe the bug (__must be provided__)**
A clear and concise description of what the bug is.
**Your Environments (__must be provided__)**
* OS: `uname -a`
* Compliler: `g++ --version` or `clang++ --version`
* CPU: `lscpu`
* Commit id (e.g. `a3ffc7d8`)
**How To Reproduce(__must be provided__)**
Steps to reproduce the behavior:
1. Step 1
2. Step 2
3. Step 3
**Expected behavior**
A clear and concise description of what you expected to happen.
**Additional context**
Provide logs and configs, or any other context to trace the problem.Below is a detailed explanation of how Nebula Graph assigns credits to each pull request level:
| Level | Level Description | Credits Assigned |
|---|---|---|
| Level 0 | Fixed a defect-p1 bug | 100 Points |
| Level 1 | Fixed a defect-p2 bug | 50 Points |
| Level 2 | Submitted pull request has been accepted | 30 Points |
| Level 3 | Fixed a defect-p3 bug OR Information added to docs has been accepted | 5 Points |
In addition to pull requests, we also welcome community members to raise issues for us. Below is a detailed description of how Nebula Graph grants credits to each issue level:
| Level | Level Description | Credits Assigned |
|---|---|---|
| Level 0 | Found a defect-p1 bug | 5 Points |
| Level 1 | Found a defect-p2 bug | 3 Points |
| Level 2 | Found a defect-p3 bug | 1 Point |
Nebula Graph has graded bugs based on its criticalness:
- defect-p1 bug: Service crash or data loss
- defect-p3 bug: Return invalid results or fatal documentation errors
- defect-p3 bug: Other not-so-critical bugs such as typos
To redeem your credits for gifts：Please DM our official Twitter handle @NebulaGraph with your GitHub account name, gift name, your name, email, and shipping address.
Below is a list of redeemable gifts:
Please DM @NebulaGraph on Twitter for gifts
Community User: 依云 👉 Current Credits: 0 📝 History Credits: 100
| Activities | Credit Changes | Credit Balance |
|---|---|---|
| Fixed a defect-p1 bug #820 | + 100 | 100 |
| Redeemed IKBC keyboard | -100 | 0 |
Community User: xieceinhe 👉 Current Credits: 0 📝 History Credits: 100
| Activities | Credit Changes | Credit Balance |
|---|---|---|
| Fixed a defect-p1 bug #978 | + 100 | 100 |
| Redeemed IKBC keyboard | -100 | 0 |
Community User: moneytoyang 👉 Current Credits: 0 📝 History Credits: 37
| Activities | Credit Changes | Credit Balance |
|---|---|---|
| Submitted pull request accepted #829 | +30 | 30 |
| Found a defect-p2 bug #826 | +3 | 33 |
| Found a defect-p2 bug #827 | +3 | 36 |
| Found a defect-p3 bug #833 | +1 | 37 |
| Redeemed two voucher cards | -20 | 17 |
| Redeemed three handbags | -9 | 8 |
| Redeemed one GitHub backpack | -8 | 0 |
Community User: walter211 👉 Current Credits: 4 📝 History Credits: 4
| Activities | Credit Changes | Credit Balance |
|---|---|---|
| Found a defect-p3 bug #830 | +1 | 1 |
| Found a defect-p2 bug #831 | +3 | 4 |
Community User: Wen Zhenghu 👉 Current Credits: 1 📝 History Credits: 1
| Activities | Credit Changes | Credit Balance |
|---|---|---|
| Found a defect-p3 bug #893 | +1 | 1 |
If you like Nebula Graph, please leave us a star.
