Skip to content

Commit e126035

Browse files
authored
Merge pull request #12 from JessicaGarson/main
Adding updates to the contribution guide. This is so helpful! Thank you!
2 parents 109320c + 3cc3c6f commit e126035

1 file changed

Lines changed: 90 additions & 2 deletions

File tree

docs/contributing.md

Lines changed: 90 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,90 @@
1-
Contributions to L5 are welcomed. Consider opening an [issue](https://github.com/L5lua/L5/issues) to discuss proposed changes. [Contributions to this website](https://github.com/L5lua/L5-website) are also welcomed.
1+
## Contributing to L5 ❤️
22

3-
We welcome all contributions including suggestions, [issues](https://github.com/L5lua/L5/issues) (bug reports), pull requests, [tutorials](https://github.com/L5lua/L5-website/issues/1) and improvements to documentation.
3+
Thanks for your interest in contributing to **L5**! Contributions of all kinds are welcome — from code and documentation to tutorials, examples, and teaching.
44

55
We are inspired by the *[all contributors](https://github.com/all-contributors/all-contributors.github.io)* approach to contribution to open source projects:
66

77
> Our community values contributions of all forms and seeks to expand the meaning of the word contributor as far and wide as possible. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. --*from [p5.js Contributor Guidelines](https://p5js.org/contribute/contributor_guidelines/)*
88
9+
If you’re new to open source, don’t worry. This guide explains **which repository to use**, **when to fork**, and **how to get started** step by step.
10+
11+
## Step 1: Decide what you want to contribute
12+
13+
L5 has **two main repositories**. Which one you use depends on *what you’re working on*.
14+
15+
### L5 - The library itself
16+
17+
Use this repository if you want to:
18+
19+
- Fix bugs in the L5 code
20+
- Add or improve features
21+
- Improve core documentation
22+
- Add examples that ship with L5
23+
24+
**Repository:** https://github.com/L5lua/L5
25+
26+
### L5 Website - The documentation site
27+
28+
Use this repository if you want to:
29+
30+
- Improve reference pages
31+
- Write or edit tutorials
32+
- Add screenshots or examples
33+
- Improve wording, structure, or beginner explanations
34+
35+
**Repository:** https://github.com/L5lua/L5-website
36+
37+
38+
## Step 2: Start with an issue
39+
40+
Before writing code or documentation, we recommend **opening an issue** to describe:
41+
42+
- A bug you found
43+
- A page that’s confusing
44+
- A feature or tutorial idea
45+
- Something you’d like to improve
46+
47+
This helps avoid duplicated work and gives you a place to ask questions.
48+
49+
### Where to file issues
50+
51+
**Library issues:** https://github.com/L5lua/L5/issues
52+
**Website issues:** https://github.com/L5lua/L5-website/issues
53+
54+
55+
## Step 3: Fork the repository
56+
57+
If you want to make changes:
58+
59+
1. **Fork** the repository you’re contributing to
60+
(either `L5` or `L5-website`)
61+
2. Clone **your fork** to your computer
62+
3. Make your changes
63+
4. Open a **Pull Request** back to the main repository
64+
65+
You do **not** need special permission to fork, and you do **not** need to create a branch in the main repository.
66+
67+
Most contributors work directly on the `main` branch of **their fork**.
68+
69+
### Example (command line)
70+
71+
After forking the repo on GitHub, clone *your fork*:
72+
73+
```bash
74+
git clone https://github.com/YOUR-USERNAME/L5-website.git
75+
cd L5-website
76+
```
77+
78+
Make your changes, then commit and push:
79+
80+
```bash
81+
git add .
82+
git commit -m "Describe your changes"
83+
git push origin main
84+
```
85+
86+
Finally, open a Pull Request on GitHub from your fork to the main repository.
87+
988
## Some ways to Help with L5
1089

1190
- **File bug reports** with detailed reproduction steps by [creating an issue](https://github.com/L5lua/L5/issues)
@@ -17,6 +96,15 @@ We are inspired by the *[all contributors](https://github.com/all-contributors/a
1796
- **Create educational content** like zines or video tutorials
1897
- **Develop add-on libraries** or document Lua ecosystem integration
1998

99+
We follow the *All Contributors* philosophy:
100+
101+
> Our community values contributions of all forms and seeks to expand the meaning of the word contributor.
102+
103+
## Contributors meetings
104+
105+
We regularly host in-person contributor meetings in NYC. All are welcome! Feel free to reach out directly if you'd like to learn more.
106+
107+
20108
## Winter 2026 L5 Survey
21109

22110
[The Winter 2026 L5 Survey is currently live](survey.md)

0 commit comments

Comments
 (0)