|
1 | 1 | ## Contributing to DGL |
2 | 2 |
|
3 | | -If you are interested in contributing to DGL, your contributions will fall |
4 | | -into two categories: |
5 | | -1. You want to propose a new Feature and implement it |
6 | | - - post about your intended feature, and we shall discuss the design and |
7 | | - implementation. Once we agree that the plan looks good, go ahead and implement it. |
8 | | -2. You want to implement a feature or bug-fix for an outstanding issue |
9 | | - - Look at the outstanding issues |
10 | | - - Especially look at the Low Priority and Medium Priority issues |
11 | | - - Pick an issue and comment on the task that you want to work on this feature |
12 | | - - If you need more context on a particular issue, please ask and we shall provide. |
13 | | - |
14 | | -Once you finish implementing a feature or bugfix, please send a Pull Request. |
| 3 | +Contribution is always welcomed. A good starting place is the roadmap issue, where |
| 4 | +you can find our current milestones. All contributions must go through pull requests |
| 5 | +and be reviewed by the committors. |
15 | 6 |
|
| 7 | +For document improvement, simply PR the change and prepend the title with `[Doc]`. |
| 8 | + |
| 9 | +For new features, we suggest first create an issue using the feature request template. |
| 10 | +Follow the template to describe the features you want to implement and your plans. |
| 11 | +We also suggest pick the features from the roadmap issue because they are more likely |
| 12 | +to be incoporated in the next release. |
| 13 | + |
| 14 | +For bug fix, we suggest first create an issue using the bug report template if the |
| 15 | +bug has not been reported yet. Please reply the issue that you'd like to help. Once |
| 16 | +the task is assigned, make the change in your fork and PR the codes. Remember to |
| 17 | +also refer to the issue where the bug is reported. |
| 18 | + |
| 19 | +Once your PR is merged, congratulation, you are now an contributor to the DGL project. |
| 20 | +We will put your name in the list below and also on our [website](https://www.dgl.ai/ack). |
| 21 | + |
| 22 | +Contributors |
| 23 | +------------ |
| 24 | +[Yizhi Liu](https://github.com/yzhliu) |
| 25 | +[Yifei Ma](https://github.com/yifeim) |
| 26 | +Hao Jin |
| 27 | +[Sheng Zha](https://github.com/szha) |
0 commit comments