Skip to content

Commit 27c1189

Browse files
committed
add Who can Contribute FAQ
1 parent 12ba865 commit 27c1189

File tree

6 files changed

+232
-127
lines changed

6 files changed

+232
-127
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ defaults:
148148
path: "_overviews/contribute"
149149
values:
150150
partof: scala-contribution
151-
overview-name: Contributing to Scala
151+
overview-name: Contributing to Scala's OSS Ecosystem
152152
layout: multipage-overview
153153
permalink: "/contribute/:title.html"
154154
-

_includes/sidebar-toc-multipage-overview.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% assign pagetype = page.type %}
22
<div class="content-nav">
33
<div class="inner-box sidebar-toc-wrapper {% if pagetype %}book{% endif %}" style="">
4-
<h5 class="contents">Contents</h5>
4+
<h5 class="contents">Contents</h5>
55
{% if pagetype %}
66
<div class="inner-toc book" id="sidebar-toc">
77
{% else %}
@@ -10,11 +10,11 @@ <h5 class="contents">Contents</h5>
1010
<ul>
1111
{% assign sorted = site[page.collection] | sort: 'num' %}
1212
{% for pg in sorted %}
13-
{% if pg.num == page.num %}
14-
{% capture toc %}
15-
<div id="toc"></div>
16-
{% endcapture %}
17-
{% endif %}
13+
{% capture toc %}
14+
{% if pg.num == page.num %}
15+
<div id="toc"></div>
16+
{% endif %}
17+
{% endcapture %}
1818

1919
{% if pg.num and (page.partof == pg.partof) %}
2020
{% if page.language %} <!-- if page is a translation, get the translated title -->
@@ -23,7 +23,7 @@ <h5 class="contents">Contents</h5>
2323
{% for lpg in site.[page.language] %}
2424
{% if lpg.id == localizedId %}
2525
<li><a {% if page.title == lpg.title %}class="active"{% endif %} href="/{{ site.baseurl }}{{ page.language }}{{ pg.url }}">{{ lpg.title }}</a>
26-
{{ toc }}</li>
26+
{{ toc }}</li>
2727
{% endif %}
2828
{% endfor %}
2929
{% else %} <!-- this must be English, so get the other documents' titles -->
@@ -44,8 +44,8 @@ <h5 class="contents">Contents</h5>
4444
{% for l in page.languages %}
4545
{% capture intermediate %}{{ page.url }}{% endcapture %}
4646
{% capture rootTutorialURL %}{{ intermediate | remove_first: '/' }}{% endcapture %}
47-
{% assign lang = site.data.languages[l] %}
48-
<li><a href="{{ site.baseurl }}/{{ l }}/{{ rootTutorialURL }}" class="lang">{{ lang.name }}</a></li>
47+
{% assign lang = site.data.languages[l] %}
48+
<li><a href="{{ site.baseurl }}/{{ l }}/{{ rootTutorialURL }}" class="lang">{{ lang.name }}</a></li>
4949
{% endfor %}
5050
</ul>
5151
{% elsif page.language %}
@@ -59,8 +59,8 @@ <h5 class="contents">Contents</h5>
5959
{% endfor %}
6060
</ul>
6161
{% endif %}
62-
</div>
63-
<hr>
64-
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
65-
</div>
62+
</div>
63+
<hr>
64+
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
65+
</div>
6666
</div>

_overviews/contribute/become-contributor.md

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Grab Bag of Stuff
3+
num: 15
4+
---
5+
6+
### Why You Should Contribute To Scala
7+
The Scala programming language is an open source project with a very
8+
diverse community, where people from all over the world contribute their work,
9+
with everyone benefiting from friendly help and advice, and
10+
kindly helping others in return. So why not join the Scala community and help
11+
everyone make things better?
12+
13+
**What Can I Do?**
14+
That depends on what you want to contribute. Below are some getting started resources for different contribution domains. Please read all the documentation and follow all the links from the topic pages below before attempting to contribute, as many of the questions you have will already be answered.
15+
16+
### Reporting bugs
17+
18+
See our [bug reporting guide][bug-reporting-guide] to learn
19+
how to efficiently report a bug.
20+
21+
### Contribute
22+
23+
Coordination of contribution efforts takes place on
24+
[Scala Contributors](https://contributors.scala-lang.org/).
25+
26+
{% include column-list-of-items.html collection=site.contribute_resources %}
27+
28+
### Guidelines
29+
30+
When contributing, please follow:
31+
32+
* The [Scala Code of Conduct](https://scala-lang.org/conduct/)
33+
* The [Inclusive Language Guide][inclusive-language-guide]
34+
35+
### Community Tickets
36+
37+
All issues can be found in the [Scala bug tracker](https://github.com/scala/bug), or the [Scala 3 issue tracker](https://github.com/lampepfl/dotty/issues). Most issues are labeled
38+
to make it easier to find issues you are interested in.
39+
40+
### Tools and Libraries
41+
42+
The Scala ecosystem includes a great many diverse open-source projects
43+
with their own maintainers and community of contributors. Helping out
44+
one of these projects is another way to help Scala. Consider lending
45+
on a hand on a project you're already using. Or, to find out about
46+
other projects, see the
47+
[Libraries and Tools section](https://scala-lang.org/community/#community-libraries-and-tools)
48+
on our Community page.
49+
50+
### Scala Community Build
51+
52+
The Scala community build enables the Scala compiler team
53+
to build and test a corpus of
54+
Scala open source projects
55+
against development versions of the Scala compiler and standard
56+
library in order to discover regressions prior to releases.
57+
The build uses Lightbend's
58+
[dbuild](https://github.com/typesafehub/dbuild) tool,
59+
which leverages [sbt](https://www.scala-sbt.org).
60+
61+
If you're the maintainer -- or just an interested user! -- of an
62+
open-source Scala library or tool, please visit the
63+
[community build documentation](https://github.com/scala/community-build/wiki)
64+
for guidelines on what projects are suitable for the community build
65+
and how projects can be added.
66+
67+
[bug-reporting-guide]: {% link _overviews/contribute/bug-reporting-guide.md %}
68+
[inclusive-language-guide]: {% link _overviews/contribute/inclusive-language-guide.md %}

0 commit comments

Comments
 (0)