Skip to content

Commit 1b8ffaf

Browse files
docs: create contribute section
1 parent 3c4c493 commit 1b8ffaf

4 files changed

Lines changed: 68 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
The repository is structured as a yarn monorepo and largely consists of codemod-kit packages and a website.
6+
7+
First, run yarn install to install dependencies.
8+
9+
## packages
10+
11+
The main function of the package is to execute predefined transforms using jscodeshift.
12+
13+
This package mainly consists of two files for providing cli and programmatic methods, and one more file for running the transformer in a browser.
14+
15+
When adding new transformers or options, please take care to add test code and documentation for them.
16+
17+
## webstie
18+
19+
The website is built with docusarus and can be run from root via `yarn start:website`.
20+
21+
If you want to edit a document, try editing it in the docs or transformer folder.
22+
23+
If you need to modify a playground, browse inside `src/page/playground`.

website/docs/contributing/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: contributing
3+
title: Contributing
4+
---
5+
6+
Thank you for your interest in contributing to codemod-kit
7+
8+
codemod-kit is a 100% community-driven project.So, from the bottom of our hearts, thank you.
9+
10+
## Getting Started
11+
12+
If you're new to open source, you may also find the [How to Contribute to Open Source](https://opensource.guide/how-to-contribute) guide from https://opensource.guide useful.
13+
14+
## Next Steps
15+
Contributions are generally made through the following process:
16+
17+
1. [Finding or opening an issue](./issue.mdx): In the issue tab, finding or creating an issue to work on.
18+
2. [Setting up a local environment](./development.mdx): Learning how to set up the local environment to start development.
19+
3. [Making a PR](./pr.mdx): Sending in your changes to resolve an accepted issue.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
## Issue Claiming
6+
7+
Anything is fine, be it a bug, documentation request, feature suggestion, etc. Please post it in the issue.
8+
9+
Please select an issue template, fill in the required fields, and submit. We will review and edit/comment on your content as quickly as possible.
10+
11+
> Please also post questions about features as issues so that we can document and work on preventing such questions from occurring in the future.
12+
13+
## Finding Issues
14+
15+
For issues with the help wanted label, you can create a pr after working on them without asking permission.
16+
17+
However, since you may be doing duplicate work, it is better to prevent this by specifying this in the issue or linking a pr in the wip state.
18+
19+
> If this is your first contribution, look for issues labeled good first issue

website/docs/contributing/pr.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
If you have worked on an issue, please create a pr. However, please do not create a pr that is not linked to an issue.
6+
7+
If you have no response for 1 month or have any questions, please ping the maintainer at any time.

0 commit comments

Comments
 (0)