-
-
Notifications
You must be signed in to change notification settings - Fork 114
Add getting started pages #616
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
abby-ql
wants to merge
6
commits into
typelevel:main
Choose a base branch
from
abby-ql:add-start-contributing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+115
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
|
|
||
| # Learning Resources | ||
|
|
||
| This is a collection of community recommended resources for functional programming in Scala and materials that help contributors understand the ideas behind Typelevel libraries. | ||
|
|
||
| > These resources are optional. You can start contributing with good first issues or examples and learn more as you go! | ||
| ## Foundational books & guides | ||
|
|
||
| - **[Functional Programming in Scala](https://www.manning.com/books/functional-programming-in-scala-second-edition)**: A classic introduction to FP ideas in Scala; strong on the thinking behind libraries like Cats. | ||
|
|
||
| - **[Scala with Cats](https://scalawithcats.com)**: Practical introduction to Cats | ||
|
|
||
| - **[Essential Scala](https://underscore.io/books/essential-scala/)**: A functionally-friendly introduction to Scala language features. | ||
|
|
||
| - **[Creative Scala](https://www.creativescala.org/creative-scala/)**: Hands-on exercises and usage for practising Scala. | ||
|
|
||
| ## Documentation for Key Libraries | ||
|
|
||
| - **[Cats Effect](https://typelevel.org/cats-effect/)**: Core to the modern Typelevel runtime model. | ||
|
|
||
| - **[FS2](https://fs2.io)**: Functional streaming library used throughout the ecosystem. | ||
|
|
||
| - **[http4s](https://http4s.org)**: Functional HTTP toolkit for Scala. | ||
|
|
||
| - **[Circe](https://circe.github.io/circe)**: JSON library for Scala. | ||
|
|
||
| - **[Laika](https://typelevel.org/Laika/)**: Site and E-book Generator and Customizable Text Markup Transformer in Scala | ||
|
|
||
|
|
||
| ## Tutorials & Courses | ||
|
|
||
| - Coursera courses [Functional Programming in Scala](https://www.coursera.org/learn/scala-functional-programming) (useful if you prefer lecture-style learning and a systematic introduction). | ||
| - Community [blog posts](https://typelevel.org/blog/) | ||
|
|
||
| ## Scala ecosystem docs | ||
|
|
||
| - **[Official Scala documentation](https://docs.scala-lang.org/)**: general language reference and guides | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
|
|
||
| # Start Contributing to Typelevel | ||
|
|
||
| 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! | ||
|
|
||
| Build something small with Cats Effect. Try streaming something with FS2. Use http4s for a simple service. Build with [Typelevel Toolkit](https://typelevel.org/blog/). Build a static site with Laika. | ||
|
|
||
| > Become a user of the ecosystem you want to contribute to. | ||
|
|
||
| Also some tips that works well across most Typelevel repositories: | ||
|
|
||
| #### Find something that can be improved | ||
| - Look for open issues, especially those labeled `good first issue` or `help wanted`. | ||
| - Browse the curated [good-first-issues board](https://github.com/orgs/typelevel/projects/1/). | ||
| - If you're already using the library, improve something that bothered you. | ||
| - Documentation and tests are excellent starting points too. | ||
|
|
||
| #### Understand the problem first | ||
| - Read the issue carefully, understand the current implementation. | ||
| - Look for existing PRs or recent comments. | ||
| - Check whether a solution was already proposed. | ||
|
|
||
| #### Communication is Key | ||
| - Comment on the issue saying you'd like to work on it and briefly describe your idea or approach. | ||
| - Ask clarifying questions if anything is unclear. | ||
| - If the change is small, you can open a draft PR early to get feedback. | ||
|
|
||
| #### Open a PR and iterate | ||
| - Fork the repo, create a branch, and implement the change. Add or update tests where appropriate. | ||
| - Open a PR with a clear description of the problem and your solution. Read the [Typelevel AI policy](https://typelevel.org/gsoc/ai.html). | ||
| - Expect review feedback, ask questions, adjust your changes, and iterate. | ||
|
|
||
| #### Where to Ask for Help | ||
| - Join the [Typelevel Discord](https://discord.gg/typelevel-632277896739946517). | ||
| - Ask in `#starting-contributing` if you're new to contributing. | ||
| - Use library-specific channels like `#cats`, `#cats-effect`, `#fs2`, or `#http4s` for more focused questions. | ||
| - You can also ask directly on a GitHub issue if your question is specific to that issue. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The blog doesn't really belong here and is already linked on the top of the page.