Skip to content

Commit 1d10e89

Browse files
move newcomer contribution to contribution guide
Co-authored-by: Jamie Thompson <bishbashboshjt@gmail.com> Co-authored-by: Anatolii Kmetiuk <anatoliykmetyuk@gmail.com>
1 parent 458507e commit 1d10e89

17 files changed

+63
-49
lines changed

_getting-started/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,15 @@ languages: [fr, ja, uk]
66
includeTOC: true
77

88
newcomer_resources:
9-
- title: "Resources For Newcomers"
10-
links:
11-
- title: Are You Coming From Java?
12-
description: What you should know to get to speed with Scala after your initial setup.
13-
icon: "fa fa-coffee"
14-
link: /scala3/newcomers/java.html
15-
- title: Scala in the Browser
16-
description: >
17-
To start experimenting with Scala right away, use "Scastie" in your browser.
18-
icon: "fa fa-cloud"
19-
link: https://scastie.scala-lang.org/pEBYc5VMT02wAGaDrfLnyw
9+
- title: Are You Coming From Java?
10+
description: What you should know to get to speed with Scala after your initial setup.
11+
icon: "fa fa-coffee"
12+
link: /scala3/newcomers/java.html
13+
- title: Scala in the Browser
14+
description: >
15+
To start experimenting with Scala right away, use "Scastie" in your browser.
16+
icon: "fa fa-cloud"
17+
link: https://scastie.scala-lang.org/pEBYc5VMT02wAGaDrfLnyw
2018

2119
redirect_from:
2220
- /getting-started.html
@@ -32,7 +30,9 @@ The instructions below cover both Scala 2 and Scala 3.
3230
{% endaltDetails %}
3331
</div>
3432

35-
{% include inner-documentation-sections.html sections=page.newcomer_resources %}
33+
## Resources For Newcomers
34+
35+
{% include inner-documentation-sections.html links=page.newcomer_resources %}
3636

3737
## Install Scala on your computer
3838

_includes/inner-documentation-sections.html

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,17 @@
22
Layouts using this include should pass an include variable called 'collection' referencing a collection carrying the data (i.e.: contribute_community_tickets, contribute_resources...)
33
{% endcomment %}
44

5-
{% for section in include.sections %}
6-
<h2 class="frontpage">{{ section.title }}</h2>
75
<div class="documentation">
8-
{% for link in section.links %}
9-
<a href="{% if link.link contains '://' %}{{link.link}}{% else %}{{site.baseurl}}{{link.link}}{% endif %}" class="doc-item doc-item-link">
10-
<div class="doc-item-header">
11-
<i class="{{link.icon}}"></i>
12-
<h4>{{link.title}}</h4>
13-
</div>
14-
<div class="doc-item-main">
15-
<p>{{link.description}}</p>
16-
</div>
6+
{% for link in include.links %}
7+
<a href="{% if link.link contains '://' %}{{link.link}}{% else %}{{site.baseurl}}{{link.link}}{% endif %}"
8+
class="doc-item doc-item-link">
9+
<div class="doc-item-header">
10+
<i class="{{link.icon}}"></i>
11+
<h4>{{link.title}}</h4>
12+
</div>
13+
<div class="doc-item-main">
14+
<p>{{link.description}}</p>
15+
</div>
1716
</a>
1817
{% endfor %}
1918
</div>
20-
{% endfor %}

_overviews/contribute/add-guides.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Add New Guides/Tutorials
3-
num: 7
3+
num: 8
44
---
55

66
## Why Contribute New Learning Material?

scala3/newcomers/contributor.md renamed to _overviews/contribute/become-contributor.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
layout: singlepage-overview
3-
title: Becoming a Scala OSS Contributor
2+
title: Contribution FAQ
3+
num: 2
44
---
5-
You are a confident Scala programmer who is looking to give back to the community. Or maybe you are only at the start of your Scala journey and are looking for good ways to improve your expertise. Regardless of your background, contributing to open source Scala libraries has its own benefits for you.
65

76
## Why contribute?
87
Open Source Software (OSS) libraries are the flesh on top of the bone structure of the core language itself. They power vast majority of the commercial and non-commercial projects out there alike.
@@ -23,7 +22,7 @@ Often, when people are talking about contributing to OSS, they think of fixing i
2322
- **Issue reproduction**. Some reported issues lack reproduction instructions at all! If a maintainer can't reproduce it, they won't be able to fix it. Pinning down exact conditions that make an issue manifest is another way to contribute.
2423
- **Open-source your own project**. Do you have a pet project you are working on? Is there anything you're working on at work parts of which are generic enough that you can share them online? Open-sourcing your work is a way to solve a problem for other programmers who may also have it. If you are interested in going open-source, here is an excellent guide on how to get started: [https://docs.scala-lang.org/overviews/contributors/index.html](https://docs.scala-lang.org/overviews/contributors/index.html).
2524

26-
## What should I contribute to?
25+
## Choosing Where to Contribute
2726
The best project to contribute to is the one that you are using yourself. Take an inventory of your work and hobby projects: what OSS libraries do they use? Have you ever encountered bugs in them? Or have you ever wanted a certain feature implemented? Pick a bug and a feature and commit to fixing or implementing it. Clone the project you are trying to improve, figure out how the tests are written and run there. Write a test for your feature or bug.
2827

2928
While implementing or fixing the feature, it is important to ask for help early when you feel stuck. Even if your code doesn't work, don't hesitate to submit a pull request while stating clearly that you need help. More information about the guidelines of good contribution you can find in the [talk by Seth Tisue](https://youtu.be/DTUpSTrnI-0) on how to be a good contributor.
@@ -33,4 +32,3 @@ If you can't immediately see a bug or feature that you personally would like to
3332
There is also an option to contribute to the Scala 3 compiler itself. The Scala Center runs the Compiler Academy project to onboard and educate new people in the Scala 3 compiler. One of the Compiler Academy projects is an Issue Spree – an event that takes place every 3 weeks where people fix Scala 3 compiler issues in pair programming sessions while learning the compiler together. You can apply for the Spree participation by [filling the form](https://forms.gle/DfoSuHFm3T6MA3L59).
3433

3534
You may want to keep an eye on the Scala Center [LinkedIn](https://www.linkedin.com/company/scala-center/) and [Twitter](https://twitter.com/scala_lang) to stay up-to-date with the possible contribution opportunities. For example, every year, the Scala Center participates in the Google Summer of Code program where you are paid to work on open source Scala projects over the course of summer.
36-

_overviews/contribute/bug-reporting-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Bug Reporting Guide
3-
num: 8
3+
num: 9
44
---
55

66
The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug), and for Scala 3, it is located at [github.com/lampepfl/dotty](https://github.com/lampepfl/dotty/issues). Before you submit a bug make sure that it is certainly a bug by following instructions

_overviews/contribute/codereviews.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Code Review Contributions
3-
num: 3
3+
num: 4
44
---
55
## Code Review Contributions
66

_overviews/contribute/corelibs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Core Library Contributions
3-
num: 4
3+
num: 5
44
---
55
## Core Library Contributions
66

_overviews/contribute/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Documentation Contributions
3-
num: 5
3+
num: 6
44
---
55
## Contributing Documentation to the Scala project
66

_overviews/contribute/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Contributing guide
3-
num: 10
3+
num: 11
44
---
55

66
| **Shortcut** | **Description** |

_overviews/contribute/hacker-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Scala 2 Hacker's Guide
33
by: Eugene Burmako
4-
num: 12
4+
num: 13
55
---
66
<br>
77
This guide is intended to help you get from an idea of fixing a bug or implementing a new feature into a nightly Scala build, and, ultimately, to a production release of Scala incorporating your idea.

_overviews/contribute/inclusive-language-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Inclusive Language Guide
3-
num: 2
3+
num: 3
44
---
55

66
We are committed to providing a friendly, safe and welcoming environment for

_overviews/contribute/index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
---
2-
title: Introduction
2+
title: Becoming a Scala OSS Contributor
33
num: 1
4+
5+
explore_resources:
6+
- title: Why Contribute?
7+
description: "Giving back to the community has many benefits..."
8+
icon: "fa fa-circle-question"
9+
link: "become-contributor.html#why-contribute"
10+
- title: Ways to Contribute
11+
description: "From documentation to coding a bug-fix, there is lots to do..."
12+
icon: "fa fa-clipboard-list"
13+
link: "become-contributor.html#ways-to-contribute"
14+
- title: Choosing Where to Contribute
15+
description: "If you are using OSS, you are already a contributor..."
16+
icon: "fa fa-check-to-slot"
17+
link: "become-contributor.html#choosing-where-to-contribute"
418
---
519

20+
Regardless of your background, contributing to open source Scala libraries has its own benefits for you.
21+
You could be a confident Scala programmer who is looking to give back to the community. Or maybe you are only at the
22+
start of your Scala journey and are looking for good ways to improve your expertise.
23+
24+
### Explore Scala OSS
25+
26+
{% include inner-documentation-sections.html links=page.explore_resources %}
27+
628
### Why You Should Contribute To Scala
729
The Scala programming language is an open source project with a very
830
diverse community, where people from all over the world contribute their work,

_overviews/contribute/partest-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Running the Test Suite
3-
num: 13
3+
num: 14
44
---
55

66
Partest is a custom parallel testing tool that we use to run the test suite for the Scala compiler and library. Go to the scala project folder from your local checkout and run it via `sbt`, `ant` or standalone as follows.

_overviews/contribute/scala-internals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Scala Contributors Forum
3-
num: 9
3+
num: 10
44
---
55

66
The [Scala Contributors Forum][scala-contributors] is where discussions about the Scala ecosystem

_overviews/contribute/scala-standard-library-api-documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Contribute to API Documentation
3-
num: 6
3+
num: 7
44
---
55

66
This page is specific to API documentation contributions – that is, API

_overviews/contribute/tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: IDE and Build Tool Contributions
3-
num: 11
3+
num: 12
44

55
# Projects list:
66
projects:

index.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,10 @@ sections:
9494
description: "The Scala Improvement Process. Language & compiler evolution."
9595
icon: "fa fa-cogs"
9696
link: /sips/index.html
97-
- title: "Contributing to Scala"
98-
description: "The Complete Guide to Contributing to Scala's compilers, libraries and documentation."
99-
icon: "fa fa-cogs"
100-
link: /contribute/
101-
- title: "Becoming a Scala OSS Contributor"
102-
description: "How to start contributing to open-source Scala ecosystem"
97+
- title: "Become a Scala OSS Contributor"
98+
description: "From start to finish: discover how you can help Scala's open-source ecosystem"
10399
icon: "fa fa-code-branch"
104-
link: /scala3/newcomers/contributor.html
100+
link: /contribute/
105101
- title: "Scala 3 Contributing Guide"
106102
description: "Guide to the Scala 3 Compiler and fixing an issue"
107103
icon: "fa fa-cogs"

0 commit comments

Comments
 (0)