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)](/contribute/scala-standard-library-api-documentation.html), [docs.scala-lang.org](https://docs.scala-lang.org/contribute.html) and [scala-lang.org](https://github.com/scala/scala-lang).
6
+
[Scaladoc (API)](/overviews/contribute/scala-standard-library-api-documentation.html), [docs.scala-lang.org](/contribute.html) and [scala-lang.org](https://github.com/scala/scala-lang).
Copy file name to clipboardExpand all lines: _overviews/contribute/bug-reporting-guide.md
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@ layout: multipage-overview
4
4
num: 7
5
5
partof: scala-contribution
6
6
overview-name: Contributing to Scala
7
-
permalink: /contribute/bug-reporting-guide.html
8
7
---
9
8
10
9
The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug). 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-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@ layout: multipage-overview
4
4
num: 5
5
5
partof: scala-contribution
6
6
overview-name: Contributing to Scala
7
-
permalink: /contribute/documentation.html
8
7
---
9
8
## Contributing Documentation to the Scala project
10
9
@@ -24,11 +23,11 @@ Thanks
24
23
25
24
The Scala API documentation lives with the scala project source code. There are many ways you can help with improving Scaladoc, including:
26
25
27
-
*[Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
26
+
*[Log issues for missing scaladoc documentation](/overviews/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
28
27
Please *follow the issue submission process closely* to help prevent duplicate issues being created.
29
-
*[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.
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.
30
29
* You can also just
31
-
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation.html)
30
+
[submit new Scaladoc](/overviews/contribute/scala-standard-library-api-documentation.html)
32
31
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.
33
32
34
33
### The Main Scala Documentation Site
@@ -45,7 +44,7 @@ without creating an issue, but please look to see if there is an issue already s
45
44
* SIP (Scala Improvement Process) Proposals
46
45
and more
47
46
48
-
Please read [contributing to the docs.scala-lang.org site](https://docs.scala-lang.org/contribute.html) through before embarking on changes. The site uses
47
+
Please read [contributing to the docs.scala-lang.org site](/contribute.html) through before embarking on changes. The site uses
49
48
the [Jekyll](https://jekyllrb.com/) markdown engine so you will need to follow the instructions to get that running as well.
50
49
51
50
### Updating scala-lang.org
@@ -56,4 +55,4 @@ to Scala and related projects) is provided on the main
56
55
[scala-lang GitHub project](https://github.com/scala/scala-lang) which may be forked to create pull requests.
57
56
58
57
Please read both the
59
-
[docs.scala-lang.org contribution](https://docs.scala-lang.org/contribute.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.
58
+
[docs.scala-lang.org contribution](/contribute.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.
<p>Learn to write good code and improve your chances of contributing to the Scala galaxy.</p>
30
29
</div>
31
30
</div>
@@ -56,22 +55,22 @@ unencumbered by copyrights or patents.
56
55
57
56
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)
58
57
59
-
1.[Select a bug to fix from GitHub](/contribute/#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
60
-
[make sure it's not a duplicate](/contribute/bug-reporting-guide.html#reporting-confirmed-bugs-is-a-sin)).
61
-
2. Optional ([but recommended](/contribute/scala-internals/#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
62
-
[these friendly people](/contribute/hacker-guide.html#1-connect) - it's one of the perks of contributing.
63
-
3.[Fork the Scala repository](/contribute/hacker-guide.html#fork) and clone your fork (if you haven't already).
64
-
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.
65
-
5.[Fix the bug, or implement the new small feature](/contribute/hacker-guide.html#implement), include new tests (yes, for bug fixes too).
66
-
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).
67
-
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.
58
+
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
59
+
[make sure it's not a duplicate](/overviews/contribute/bug-reporting-guide.html#reporting-confirmed-bugs-is-a-sin)).
60
+
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
61
+
[these friendly people](/overviews/contribute/hacker-guide.html#1-connect) - it's one of the perks of contributing.
62
+
3.[Fork the Scala repository](/overviews/contribute/hacker-guide.html#fork) and clone your fork (if you haven't already).
63
+
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.
64
+
5.[Fix the bug, or implement the new small feature](/overviews/contribute/hacker-guide.html#implement), include new tests (yes, for bug fixes too).
65
+
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).
66
+
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.
68
67
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](
69
68
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)
70
-
9.[Submit a pull request](./hacker-guide.html#submit).
71
-
10.[Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/contribute/hacker-guide.html#review).
69
+
9.[Submit a pull request](/overviews/contribute/hacker-guide.html#submit).
70
+
10.[Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/overviews/contribute/hacker-guide.html#review).
72
71
11. Celebrate!
73
72
74
-
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](./hacker-guide.html) 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).
73
+
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](/overviews/contribute/hacker-guide.html) 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).
75
74
76
75
### Larger Changes, New Features
77
76
@@ -80,4 +79,4 @@ and on the implementation plan. Announce the change
80
79
on the [Scala Contributors](https://contributors.scala-lang.org/) mailing list and get developer feedback. For really complex changes, a [Scala Improvement Process (SIP)](https://docs.scala-lang.org/sips/) document might be required, but the first step is always to discuss it on the mailing list and if a SIP is required, that will be discussed on the mailing list.
81
80
82
81
Contributions, big or small, simple or complex, controversial or undisputed, need to materialize as patches against
83
-
the Scala project source tree. The [hacker guide](/contribute/hacker-guide.html) will explain how to materialize your idea into a full-fledged pull request against the Scala code base.
82
+
the Scala project source tree. The [hacker guide](/overviews/contribute/hacker-guide.html) will explain how to materialize your idea into a full-fledged pull request against the Scala code base.
0 commit comments