Skip to content

Commit 1801876

Browse files
committed
Create a contributing to OR doc
1 parent eb3fad7 commit 1801876

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
sidebar_label: Contributing to OpenRewrite
3+
description: How to contribute back to the OpenRewrite community
4+
---
5+
6+
# Contributing to OpenRewrite
7+
8+
If you've written your own recipes, you might want to contribute back to the OpenRewrite community. For any new contribution, the first thing to check is whether there is already a corresponding [issue on the backlog](https://github.com/orgs/openrewrite/projects/4/views/10), perhaps with some pointers on an implementation. If not, you can [create a new issue](https://github.com/openrewrite/rewrite-spring/issues/new/choose) to discuss the recipe you'd like to develop.
9+
10+
We have some [good first issues](https://github.com/orgs/openrewrite/projects/4/views/10?filterQuery=-label%3A%22parser\*%22+label%3A%22good+first+issue%22) in particular that are great when you're just starting out and want feedback on your work to help improve your skills.
11+
12+
Note that there are separate modules for Spring recipes, Java recipes, testing recipes, logging recipes, and many more. It helps to browse the existing modules for any related work that might be similar and start from there.
13+
14+
For any further questions, feel free to ask in the [OpenRewrite Slack](https://join.slack.com/t/rewriteoss/shared_invite/zt-nj42n3ea-b\~62rIHzb3Vo0E1APKCXEA) or [Discord](https://discord.gg/xk3ZKrhWAb). Hope to see you there!

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ const sidebars: SidebarsConfig = {
7979
'authoring-recipes/writing-recipes-over-multiple-source-file-types',
8080
'authoring-recipes/estimated-time-saved',
8181
'authoring-recipes/multiple-versions',
82+
'authoring-recipes/contributing-to-openrewrite',
8283
{
8384
type: 'link',
8485
label: 'Recipe authoring workshop',

0 commit comments

Comments
 (0)