Skip to content

Commit 0ff420d

Browse files
committed
tweaks to start contributing guide
- don't say it's simple - links to suggestions and put them in a list - use bold instead of incorrect subheading levels - add AI note
1 parent c030f13 commit 0ff420d

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,42 @@
11

22
# Start Contributing to Typelevel
33

4-
Typelevel projects power a large part of the functional Scala ecosystem. They are also complex, long-lived codebases with active communities. Contributing can feel intimidating at first, but the path in is actually quite simple!
4+
Typelevel projects power a large part of the functional Scala ecosystem. They are also complex, long-lived codebases with active communities. Contributing can feel intimidating at first, but even bug reports, small fixes, and documentation updates help move our projects forward!
55

6-
Build something small with Cats Effect. Try streaming something with FS2. Use http4s for a simple service. Build with [Typelevel Toolkit](https://typelevel.org/toolkit/). Build a static site with Laika.
76

8-
> Become a user of the ecosystem you want to contribute to.
7+
**Become a user of the ecosystem you want to contribute to.**
98

10-
Also some tips that works well across most Typelevel repositories:
9+
- Use the [Typelevel Toolkit](https://typelevel.org/toolkit/) to experiment with [Cats](https://typelevel.org/cats) and [Cats Effect](https://typelevel.org/cats-effect/).
10+
- Try streaming something with [FS2](https://fs2.io/#/).
11+
- Use [http4s](https://http4s.org/) for a simple service.
12+
- Build a static site with [Laika](https://typelevel.org/Laika).
1113

12-
#### Find something that can be improved
14+
15+
**Find something that can be improved**
1316
- Look for open issues, especially those labeled `good first issue` or `help wanted`.
1417
- Browse the curated [good-first-issues board](https://github.com/orgs/typelevel/projects/1/).
1518
- If you're already using the library, improve something that bothered you.
1619
- Documentation and tests are excellent starting points too.
1720

18-
#### Understand the problem first
21+
**Understand the problem**
1922
- Read the issue carefully, understand the current implementation.
2023
- Look for existing PRs or recent comments.
2124
- Check whether a solution was already proposed.
2225

23-
#### Communication is Key
26+
**Communication with the community**
2427
- Comment on the issue saying you'd like to work on it and briefly describe your idea or approach.
2528
- Ask clarifying questions if anything is unclear.
2629
- If the change is small, you can open a draft PR early to get feedback.
2730

28-
#### Open a PR and iterate
31+
**Open a PR and iterate**
2932
- Fork the repo, create a branch, and implement the change. Add or update tests where appropriate.
3033
- Open a PR with a clear description of the problem and your solution.
3134
- Expect review feedback, ask questions, adjust your changes, and iterate.
3235

33-
#### Where to Ask for Help
36+
## Where to Ask for Help
3437
- Join the [Typelevel Discord](https://discord.gg/typelevel-632277896739946517).
3538
- Ask in `#starting-contributing` if you're new to contributing.
3639
- Use library-specific channels like `#cats`, `#cats-effect`, `#fs2`, or `#http4s` for more focused questions.
3740
- You can also ask directly on a GitHub issue if your question is specific to that issue.
41+
42+
> **Note:** This guide emphasises learning and understanding. While most Typelevel projects accept AI written contributions, simply using such tools to fix a bug does not help you learn the codebase and gain the understanding needed to make more significant contributions.

0 commit comments

Comments
 (0)