Skip to content

Commit 0f7a1e9

Browse files
authored
Merge pull request #6 from codegen-sh/vishal/fixes
Fixes to docs
2 parents 0cc6ba0 + bcb3ec0 commit 0f7a1e9

File tree

2 files changed

+35
-5
lines changed

2 files changed

+35
-5
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing to Codegen Examples
2+
3+
Thank you for your interest in contributing to `codegen-examples`! This document outlines the process and guidelines for contributing.
4+
5+
## Contributor License Agreement
6+
7+
By contributing to Codegen Examples, you agree that:
8+
9+
1. Your contributions will be licensed under the project's license.
10+
2. You have the right to license your contribution under the project's license.
11+
3. You grant Codegen a perpetual, worldwide, non-exclusive, royalty-free license to use your contribution.
12+
13+
## Pull Request Process
14+
15+
1. Fork the repository and create your branch from `main`.
16+
2. Ensure your code passes all tests.
17+
3. Update documentation as needed.
18+
4. Submit a pull request to the `main` branch.
19+
5. Include a clear description of your changes in the PR.
20+

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,29 @@
22

33
[![Documentation](https://img.shields.io/badge/docs-docs.codegen.com-blue)](https://docs.codegen.com)
44

5-
A collection of example transformations using [Codegen](https://github.com/codegen-sh/graph-sitter).
5+
This is a collection of examples using [Codegen](https://codegen.com). You can use these examples to learn how to use Codegen and build custom code transformations.
66

77
## Setup
88

99
We recommend using [`uv`](https://github.com/astral-sh/uv) with Python 3.13 for the best experience.
1010

11+
First, install uv if you haven't already
1112
```bash
12-
# Install uv if you haven't already
1313
brew install uv
14+
```
1415

15-
# Create and activate a Python 3.13 virtual environment
16+
Create and activate a Python 3.13 virtual environment
17+
```bash
1618
uv venv --python 3.13.0 && source .venv/bin/activate
19+
```
1720

18-
# Install Codegen
21+
Install the `codegen` package
22+
```bash
1923
uv pip install codegen
24+
```
2025

21-
# Optional: Install Jupyter for interactive exploration
26+
__Optional__: Install Jupyter for interactive exploration
27+
```bash
2228
uv pip install jupyterlab && jupyter lab
2329
```
2430

@@ -39,3 +45,7 @@ Each directory contains a self-contained example with:
3945
## Contributing
4046

4147
Have a useful example to share? We'd love to include it! Please see our [Contributing Guide](CONTRIBUTING.md) for instructions.
48+
49+
## License
50+
51+
The [Apache 2.0 license](LICENSE).

0 commit comments

Comments
 (0)