You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Scaladoc (API)](/overviews/contribute/scala-standard-library-api-documentation.html), [docs.scala-lang.org](/overviews/contribute/add-guides.html) and [scala-lang.org](https://github.com/scala/scala-lang).
6
+
[Scaladoc (API)](/contribute/scala-standard-library-api-documentation.html), [docs.scala-lang.org](/contribute/add-guides.html) and [scala-lang.org](https://github.com/scala/scala-lang).
Copy file name to clipboardExpand all lines: _overviews/contribute/bug-reporting-guide.md
-3
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,6 @@
1
1
---
2
2
title: Bug Reporting Guide
3
-
layout: multipage-overview
4
3
num: 8
5
-
partof: scala-contribution
6
-
overview-name: Contributing to Scala
7
4
---
8
5
9
6
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 in *Is it a Bug?*.
Copy file name to clipboardExpand all lines: _overviews/contribute/documentation.md
+5-8
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,6 @@
1
1
---
2
2
title: Documentation Contributions
3
-
layout: multipage-overview
4
3
num: 5
5
-
partof: scala-contribution
6
-
overview-name: Contributing to Scala
7
4
---
8
5
## Contributing Documentation to the Scala project
9
6
@@ -23,11 +20,11 @@ Thanks
23
20
24
21
The Scala API documentation lives with the scala project source code. There are many ways you can help with improving Scaladoc, including:
25
22
26
-
*[Log issues for missing scaladoc documentation](/overviews/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
23
+
*[Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
27
24
Please *follow the issue submission process closely* to help prevent duplicate issues being created.
28
-
*[Claim Scaladoc Issues and Provide Documentation](/overviews/contribute/scala-standard-library-api-documentation.html) - please claim issues prior to working on a specific scaladoc task to prevent duplication of effort. If you sit on an issue for too long without submitting a pull request, it will revert back to unassigned and you will need to re-claim it.
25
+
*[Claim Scaladoc Issues and Provide Documentation](/contribute/scala-standard-library-api-documentation.html) - please claim issues prior to working on a specific scaladoc task to prevent duplication of effort. If you sit on an issue for too long without submitting a pull request, it will revert back to unassigned and you will need to re-claim it.
29
26
* You can also just
30
-
[submit new Scaladoc](/overviews/contribute/scala-standard-library-api-documentation.html)
27
+
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation.html)
31
28
without creating an issue, but please look to see if there is an issue already submitted for your task and claim it if there is. If not, please post your intention to work on a specific scaladoc task on [Scala Contributors](https://contributors.scala-lang.org/) so that people know what you are doing.
32
29
33
30
### The Main Scala Documentation Site
@@ -44,7 +41,7 @@ without creating an issue, but please look to see if there is an issue already s
44
41
* SIP (Scala Improvement Process) Proposals
45
42
and more
46
43
47
-
Please read [Add New Guides/Tutorials](/overviews/contribute/add-guides.html) through before embarking on changes. The site uses
44
+
Please read [Add New Guides/Tutorials](/contribute/add-guides.html) through before embarking on changes. The site uses
48
45
the [Jekyll](https://jekyllrb.com/) markdown engine so you will need to follow the instructions to get that running as well.
49
46
50
47
### Updating scala-lang.org
@@ -55,4 +52,4 @@ to Scala and related projects) is provided on the main
55
52
[scala-lang GitHub project](https://github.com/scala/scala-lang) which may be forked to create pull requests.
56
53
57
54
Please read both the
58
-
[Add New Guides/Tutorials](/overviews/contribute/add-guides.html) document and the [scala-lang.org GitHub README](https://github.com/scala/scala-lang#scala-langorg) before embarking on any changes to the Scala language site, as it uses the same Jekyll markdown tool and many of the same conventions as the Scala documentation site.
55
+
[Add New Guides/Tutorials](/contribute/add-guides.html) document and the [scala-lang.org GitHub README](https://github.com/scala/scala-lang#scala-langorg) before embarking on any changes to the Scala language site, as it uses the same Jekyll markdown tool and many of the same conventions as the Scala documentation site.
Copy file name to clipboardExpand all lines: _overviews/contribute/guide.md
+14-17
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,6 @@
1
1
---
2
2
title: Contributing guide
3
-
layout: multipage-overview
4
3
num: 10
5
-
partof: scala-contribution
6
-
overview-name: Contributing to Scala
7
4
---
8
5
9
6
|**Shortcut**|**Description**|
@@ -41,19 +38,19 @@ unencumbered by copyrights or patents.
41
38
42
39
This is the impatient developer's checklist for the steps to submit a bug-fix pull request to the Scala project. For more information, description and justification for the steps, follow the links in that step. Further specific instructions for the release of Scala you are targeting can be found in the `CONTRIBUTING.md` file for that [GitHub branch](https://github.com/scala/scala)
43
40
44
-
1.[Select a bug to fix from GitHub](/overviews/contribute/index.html#community-tickets), or if you found the bug yourself and want to fix it, [create a GitHub issue](/overviews/contribute/bug-reporting-guide.html) (but please
45
-
[make sure it's not a duplicate](/overviews/contribute/bug-reporting-guide.html#please-check-before-reporting-a-bug)).
46
-
2. Optional ([but recommended](/overviews/contribute/scala-internals.html/#why-its-a-good-idea)), announce your intention to work on the bug on [Scala Contributors](https://contributors.scala-lang.org/). After all, don't you want to work on a team with
47
-
[these friendly people](/overviews/contribute/hacker-guide.html#1-connect) - it's one of the perks of contributing.
48
-
3.[Fork the Scala repository](/overviews/contribute/hacker-guide.html#fork) and clone your fork (if you haven't already).
49
-
4.[Create a feature branch](/overviews/contribute/hacker-guide.html#branch) to work on: use the branch name `issue/NNNN` where NNNN is the GitHub issue number.
50
-
5.[Fix the bug, or implement the new small feature](/overviews/contribute/hacker-guide.html#implement), include new tests (yes, for bug fixes too).
51
-
6.[Test, rinse](/overviews/contribute/hacker-guide.html#test) and [test some more](/overviews/contribute/partest-guide.html) until [all the tests pass](/overviews/contribute/hacker-guide.html#verify).
52
-
7.[Commit your changes](/overviews/contribute/hacker-guide.html#commit) to your feature branch in your fork. Please choose your commit message based on the [Git Hygiene](https://github.com/scala/scala#user-content-git-hygiene) section of the Scala project README.
41
+
1.[Select a bug to fix from GitHub](/contribute/index.html#community-tickets), or if you found the bug yourself and want to fix it, [create a GitHub issue](/contribute/bug-reporting-guide.html) (but please
42
+
[make sure it's not a duplicate](/contribute/bug-reporting-guide.html#please-check-before-reporting-a-bug)).
43
+
2. Optional ([but recommended](/contribute/scala-internals.html/#why-its-a-good-idea)), announce your intention to work on the bug on [Scala Contributors](https://contributors.scala-lang.org/). After all, don't you want to work on a team with
44
+
[these friendly people](/contribute/hacker-guide.html#1-connect) - it's one of the perks of contributing.
45
+
3.[Fork the Scala repository](/contribute/hacker-guide.html#fork) and clone your fork (if you haven't already).
46
+
4.[Create a feature branch](/contribute/hacker-guide.html#branch) to work on: use the branch name `issue/NNNN` where NNNN is the GitHub issue number.
47
+
5.[Fix the bug, or implement the new small feature](/contribute/hacker-guide.html#implement), include new tests (yes, for bug fixes too).
48
+
6.[Test, rinse](/contribute/hacker-guide.html#test) and [test some more](/contribute/partest-guide.html) until [all the tests pass](/contribute/hacker-guide.html#verify).
49
+
7.[Commit your changes](/contribute/hacker-guide.html#commit) to your feature branch in your fork. Please choose your commit message based on the [Git Hygiene](https://github.com/scala/scala#user-content-git-hygiene) section of the Scala project README.
53
50
8. If necessary [re-write git history](https://git-scm.com/book/en/Git-Branching-Rebasing) so that [commits are organized by major steps to the fix/feature](
54
51
https://github.com/scala/scala#git-hygiene). For bug fixes, a single commit is requested, for features several commits may be desirable (but each separate commit must compile and pass all tests)
55
-
9.[Submit a pull request](/overviews/contribute/hacker-guide.html#submit).
56
-
10.[Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/overviews/contribute/hacker-guide.html#review).
52
+
9.[Submit a pull request](/contribute/hacker-guide.html#submit).
53
+
10.[Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/contribute/hacker-guide.html#review).
57
54
11. Celebrate!
58
55
59
56
Need more information or a little more hand-holding for the first one? We got you covered: take a read through the entire [Hacker Guide][hackers] (or the [equivalent Scala 3 Contributing Guide][scala3-hackers]) for an example of implementing a new feature (some of the steps can be skipped for bug fixes, this will be obvious from reading it, but many of the steps here will help with bug fixes too).
@@ -67,8 +64,8 @@ on the [Scala Contributors](https://contributors.scala-lang.org/) mailing list a
67
64
Contributions, big or small, simple or complex, controversial or undisputed, need to materialize as patches against
68
65
the Scala project source tree. The hacker's guides ([Scala 2][hackers], or [Scala 3][scala3-hackers]) will explain how to materialize your idea into a full-fledged pull request against the Scala code base.
Copy file name to clipboardExpand all lines: _overviews/contribute/hacker-guide.md
+1-4
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,7 @@
1
1
---
2
2
title: Scala hacker guide
3
3
by: Eugene Burmako
4
-
layout: multipage-overview
5
4
num: 12
6
-
partof: scala-contribution
7
-
overview-name: Contributing to Scala
8
5
---
9
6
<br>
10
7
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.
@@ -310,7 +307,7 @@ This means your change is backward or forward binary incompatible with the speci
310
307
311
308
### Verify
312
309
313
-
Now to make sure that my fix doesn't break anything I need to run the test suite. The Scala test suite uses [JUnit](https://junit.org/junit4/) and [partest](/overviews/contribute/partest-guide.html), a tool we wrote for testing Scala.
310
+
Now to make sure that my fix doesn't break anything I need to run the test suite. The Scala test suite uses [JUnit](https://junit.org/junit4/) and [partest](/contribute/partest-guide.html), a tool we wrote for testing Scala.
314
311
Run `sbt test` and `sbt partest` to run all of the JUnit and partest tests, respectively.
315
312
`partest` (not `sbt partest`) also allows you to run a subset of the tests using wildcards:
Copy file name to clipboardExpand all lines: _overviews/contribute/partest-guide.md
-3
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,6 @@
1
1
---
2
2
title: Running the Test Suite
3
-
layout: multipage-overview
4
3
num: 13
5
-
partof: scala-contribution
6
-
overview-name: Contributing to Scala
7
4
---
8
5
9
6
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.
0 commit comments