|
1 |
| -## Contributing In General |
| 1 | +# Contributing |
2 | 2 |
|
3 |
| -Our project welcomes external contributions! If you have an itch, please |
4 |
| -feel free to scratch it. |
| 3 | +This is an open source project, and we appreciate your help! |
5 | 4 |
|
6 |
| -To contribute code or documentation, please submit a pull request to the [GitHub |
7 |
| -repository](https://github.com/IBM/pixiedust-traffic-analysis). |
| 5 | +We use the GitHub issue tracker to discuss new features and non-trivial bugs. |
8 | 6 |
|
9 |
| -A good way to familiarize yourself with the codebase and contribution process is |
10 |
| -to look for and tackle low-hanging fruit in the [issue |
11 |
| -tracker](https://github.com/IBM/pixiedust-traffic-analysis/issues). Before embarking on |
12 |
| -a more ambitious contribution, please quickly [get in touch](#communication) |
13 |
| -with us. |
| 7 | +In addition to the issue tracker, [#journeys on |
| 8 | +Slack](https://dwopen.slack.com) is the best way to get into contact with the |
| 9 | +project's maintainers. |
14 | 10 |
|
15 |
| -**We appreciate your effort, and want to avoid a situation where a contribution |
16 |
| -requires extensive rework (by you or by us), sits in the queue for a long time, |
17 |
| -or cannot be accepted at all!** |
18 |
| - |
19 |
| -### Proposing new features |
20 |
| - |
21 |
| -If you would like to implement a new feature, please [raise an |
22 |
| -issue](https://github.com/IBM/pixiedust-traffic-analysis/issues) before sending a pull |
23 |
| -request so the feature can be discussed. This is to avoid you spending your |
24 |
| -valuable time working on a feature that the project developers are not willing |
25 |
| -to accept into the code base. |
26 |
| - |
27 |
| -### Fixing bugs |
28 |
| - |
29 |
| -If you would like to fix a bug, please [raise an |
30 |
| -issue](https://github.com/IBM/pixiedust-traffic-analysis/issues) before sending a pull |
31 |
| -request so it can be discussed. If the fix is trivial or non controversial then |
32 |
| -this is not usually necessary. |
33 |
| - |
34 |
| -### Merge approval |
35 |
| - |
36 |
| -The project maintainers use LGTM (Looks Good To Me) in comments on the code |
37 |
| -review to indicate acceptance. A change requires LGTMs from two of the |
38 |
| -maintainers of each component affected. |
39 |
| - |
40 |
| -For more details, see the [MAINTAINERS](MAINTAINERS.md) page. |
41 |
| - |
42 |
| -## Communication |
43 |
| - |
44 |
| -Please feel free to connect with us: |
45 |
| -https://github.com/IBM/pixiedust-traffic-analysis/issues |
46 |
| - |
47 |
| -## Setup |
48 |
| - |
49 |
| -Please add any special setup instructions for your project to help the |
50 |
| -developer become productive quickly. |
51 |
| - |
52 |
| -## Testing |
53 |
| - |
54 |
| -Please provide information that helps the developer test any changes they |
55 |
| -make before submitting. |
56 |
| - |
57 |
| -## Coding style guidelines |
58 |
| - |
59 |
| -Beautiful code rocks! Please share any specific style guidelines you might |
60 |
| -have for your project. |
| 11 | +To contribute code, documentation, or tests, please submit a pull request to |
| 12 | +the GitHub repository. Generally, we expect two maintainers to review your pull |
| 13 | +request before it is approved for merging. For more details, see the |
| 14 | +[MAINTAINERS](MAINTAINERS.md) page. |
0 commit comments