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