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
Copy file name to clipboardExpand all lines: _contribute_resources/1-documentation.md
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,4 +3,7 @@ title: Documentation
3
3
link: /contribute/documentation.html
4
4
icon: fa fa-book
5
5
---
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).
6
+
[Scaladoc (API)][scala-standard-library-api-documentation], [docs.scala-lang.org][add-guides] and [scala-lang.org](https://github.com/scala/scala-lang).
7
+
8
+
[add-guides]: {% link _overviews/contribute/add-guides.md %}
9
+
[scala-standard-library-api-documentation]: {% link _overviews/contribute/scala-standard-library-api-documentation.md %}
Copy file name to clipboardExpand all lines: _overviews/contribute/add-guides.md
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ num: 7
5
5
6
6
## Why Contribute New Learning Material?
7
7
8
-
As [Heather Miller writes](/contribute.html), contributing to [docs.scala-lang.org](https://docs.scala-lang.org) is
8
+
As [Heather Miller writes][why-contribute], contributing to [docs.scala-lang.org][home] is
9
9
critical to making Scala accessible to newcomers, experience programmers, and anyone who is curious.
10
10
It is also a fantastic way to contribute for anyone who is comfortable using Scala, but maybe does not want to get
11
11
involved with complex tools like the compiler.
@@ -45,7 +45,7 @@ For one to contribute a document, one must simply
45
45
[repo](https://github.com/scala/docs.scala-lang), write their article in
46
46
[Markdown](https://daringfireball.net/projects/markdown/syntax) (example below), and submit a pull request. That's it.
47
47
Likely after some edits and discussion, your document will be made live
48
-
on [docs.scala-lang.org](https://docs.scala-lang.org).
48
+
on [docs.scala-lang.org][home].
49
49
50
50
---
51
51
layout: overview
@@ -71,7 +71,7 @@ styling is already taken care of for you.
71
71
### Criteria for Docs to be Accepted
72
72
73
73
The goal of this documentation repository is to be tighter and more organized than other community-driven documentation platforms, like wikis. As such, any document pulled in for inclusion on
Copy file name to clipboardExpand all lines: _overviews/contribute/bug-reporting-guide.md
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ If you have a code snippet that is resulting in bytecode which you believe is be
41
41
42
42
5. If you want to file an improvement in the issue tracker please discuss it first on one of the mailing lists. They offer much bigger audience than issue tracker. The latter is not suitable for long discussions.
43
43
44
-
* Keep in mind that the behavior you are witnessing could be intended. Good formal resources for verifying whether or not the language behavior is intended is either in the [Scala Improvement Proposal Documents](https://docs.scala-lang.org/sips/) or in the [Scala Language Specification](https://www.scala-lang.org/files/archive/spec/2.13/). If in doubt, you may always ask on the [Community Category](https://contributors.scala-lang.org/c/community) or [Stack Overflow](https://stackoverflow.com/questions/tagged/scala).
44
+
* Keep in mind that the behavior you are witnessing could be intended. Good formal resources for verifying whether or not the language behavior is intended is either in the [Scala Improvement Proposal Documents][sips] or in the [Scala Language Specification](https://www.scala-lang.org/files/archive/spec/2.13/). If in doubt, you may always ask on the [Community Category](https://contributors.scala-lang.org/c/community) or [Stack Overflow](https://stackoverflow.com/questions/tagged/scala).
45
45
46
46
In general, if you find yourself stuck on any of these steps, asking on [Scala Contributors](https://contributors.scala-lang.org/) can be helpful:
47
47
@@ -85,3 +85,5 @@ List(1, 2, 3).map(x => x + 1)
85
85
3. The actual output, including the stacktrace.
86
86
4. Related discussion on the mailing lists, if applicable.
87
87
5. If you have already looked into the issue provide interesting insights or proposals for fixing the issue.
Copy file name to clipboardExpand all lines: _overviews/contribute/documentation.md
+11-6Lines changed: 11 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -20,16 +20,16 @@ Thanks
20
20
21
21
The Scala API documentation lives with the scala project source code. There are many ways you can help with improving Scaladoc, including:
22
22
23
-
*[Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
23
+
*[Log issues for missing scaladoc documentation][report-api-doc-bugs] -
24
24
Please *follow the issue submission process closely* to help prevent duplicate issues being created.
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.
25
+
*[Claim Scaladoc Issues and Provide Documentation][scala-standard-library-api-documentation] - 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.
26
26
* You can also just
27
-
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation.html)
27
+
[submit new Scaladoc][scala-standard-library-api-documentation]
28
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.
29
29
30
30
### The Main Scala Documentation Site
31
31
32
-
[docs.scala-lang.org](https://docs.scala-lang.org/) houses the primary source of written, non-API documentation for Scala. It's a GitHub project that you can fork and submit pull requests from. It includes:
32
+
[docs.scala-lang.org][home] houses the primary source of written, non-API documentation for Scala. It's a GitHub project that you can fork and submit pull requests from. It includes:
33
33
34
34
* Overviews
35
35
* Tutorials
@@ -41,7 +41,7 @@ without creating an issue, but please look to see if there is an issue already s
41
41
* SIP (Scala Improvement Process) Proposals
42
42
and more
43
43
44
-
Please read [Add New Guides/Tutorials](/contribute/add-guides.html) through before embarking on changes. The site uses
44
+
Please read [Add New Guides/Tutorials][add-guides] through before embarking on changes. The site uses
45
45
the [Jekyll](https://jekyllrb.com/) markdown engine so you will need to follow the instructions to get that running as well.
46
46
47
47
### Updating scala-lang.org
@@ -52,4 +52,9 @@ to Scala and related projects) is provided on the main
52
52
[scala-lang GitHub project](https://github.com/scala/scala-lang) which may be forked to create pull requests.
53
53
54
54
Please read both the
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.
55
+
[Add New Guides/Tutorials][add-guides] 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.
56
+
57
+
[report-api-doc-bugs]: {% link _overviews/contribute/scala-standard-library-api-documentation.md %}#contribute-api-documentation-bug-reports
58
+
[scala-standard-library-api-documentation]: {% link _overviews/contribute/scala-standard-library-api-documentation.md %}
59
+
[home]: {% link index.md %}
60
+
[add-guides]: {% link _overviews/contribute/add-guides.md %}
Copy file name to clipboardExpand all lines: _overviews/contribute/guide.md
+28-15Lines changed: 28 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -38,19 +38,19 @@ unencumbered by copyrights or patents.
38
38
39
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)
40
40
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.
41
+
1.[Select a bug to fix from GitHub][community-tickets], or if you found the bug yourself and want to fix it, [create a GitHub issue][bug-reporting-guide] (but please
42
+
[make sure it's not a duplicate][bug-report-check-dupes]).
43
+
2. Optional ([but recommended][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][hackers-connect] - it's one of the perks of contributing.
45
+
3.[Fork the Scala repository][hackers-fork] and clone your fork (if you haven't already).
46
+
4.[Create a feature branch][hackers-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][hackers-implement], include new tests (yes, for bug fixes too).
48
+
6.[Test, rinse][hackers-test] and [test some more][partest-guide] until [all the tests pass][hackers-verify].
49
+
7.[Commit your changes][hackers-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.
50
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](
51
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)
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).
52
+
9.[Submit a pull request][hackers-submit].
53
+
10.[Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in][hackers-review].
54
54
11. Celebrate!
55
55
56
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).
@@ -59,13 +59,26 @@ Need more information or a little more hand-holding for the first one? We got yo
59
59
60
60
For larger, more ambitious changes (e.g. new language features), the first step to making a change is to discuss it with the community at large, to make sure everyone agrees on the idea
61
61
and on the implementation plan. Announce the change
62
-
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.
62
+
on the [Scala Contributors](https://contributors.scala-lang.org/) mailing list and get developer feedback. For really complex changes, a [Scala Improvement Process (SIP)][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.
63
63
64
64
Contributions, big or small, simple or complex, controversial or undisputed, need to materialize as patches against
65
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.
0 commit comments