Skip to content

Commit 72f6b45

Browse files
Merge pull request scala#679 from scala/pr/667
Scala-lang redesign
2 parents 98cab4f + 290816e commit 72f6b45

17 files changed

+187
-212
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Documentation
3+
link: /contribute/documentation/
4+
icon: fa fa-file-text
5+
---
6+
[Scaladoc (API)](/contribute/scala-standard-library-api-documentation/),[docs.scala-lang.org](http://docs.scala-lang.org/contribute.html) and [scala-lang.org](https://github.com/scala/scala-lang).

_contribute_resources/2-bug-fixes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Bug fixes
3+
link: /contribute/guide/
4+
icon: fa fa-pencil
5+
---
6+
Issues with the tools, core libraries and compiler. Also you can help us by [reporting bugs](/contribute/bug-reporting-guide/).
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Code Reviews
3+
link: /contribute/codereviews/
4+
icon: fa fa-eye
5+
---
6+
Review pull requests against [scala/scala](https://github.com/scala/scala/pulls),
7+
[scala/scala-lang](https://github.com/scala/scala-lang/pulls),
8+
[scala/scala.github.com](https://github.com/scala/scala.github.com/pulls)and others.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Core Libraries
3+
link: /contribute/corelibs/
4+
icon: fa fa-clipboard
5+
---
6+
Update and expand the capabilities of the core (and associated) Scala libraries.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: IDE and Build Tools
3+
link: /contribute/tools/
4+
icon: fa fa-terminal
5+
---
6+
Enhance the Scala tools with features for build tools, IDE plug-ins and other related projects.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Compiler/Language
3+
link: /contribute/guide/#larger-changes-new-features
4+
icon: fa fa-gears
5+
---
6+
Larger language features and compiler enhancements including language specification and SIPs.

contribute/bug-reporting-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Bug Reporting
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/bug-reporting-guide/
5+
includeTOC: true
46
---
57

68
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?*.

contribute/codereviews.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
layout: page
32
title: Code Review Contributions
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/codereviews/
5+
includeTOC: true
46
---
57
## Code Review Contributions
68

7-
In addition to [bug fixing](./guide.html), you can help us review
9+
In addition to [bug fixing](/contribute/guide/), you can help us review
810
[waiting pull requests](#pull-requests-awaiting-comment).
911
This is also a good (and recommended) way to get to know the feel of
1012
the bug-fixing and submissions process before jumping in with your
@@ -13,7 +15,7 @@ own pull requests.
1315

1416
### Review Guidelines
1517

16-
[Code of Conduct reminder](../conduct.html)
18+
[Code of Conduct reminder](/conduct/)
1719

1820
* Keep comments on-topic, concise and precise.
1921
* Attach comments to particular lines or regions they pertain to whenever possible.
@@ -49,4 +51,4 @@ own pull requests.
4951
</div>
5052
</div>
5153

52-
Also note that the [Tools contributions](./tools.html) page has more projects that will generate pull requests.
54+
Also note that the [Tools contributions](/contribute/tools/) page has more projects that will generate pull requests.

contribute/corelibs.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
2-
layout: page
32
title: Core Library Contributions
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/corelibs/
5+
includeTOC: true
46
---
57
## Core Library Contributions
68

79
There are several options for contributing to Scala's core libraries. You can:
810

9-
* Help with [Documentation](./scala-standard-library-api-documentation.html).
10-
* [Report Bugs or Issues](./bug-reporting-guide.html) against the core libraries.
11-
* [Fix Bugs or Issues](./guide.html) against the
11+
* Help with [Documentation](/contribute/scala-standard-library-api-documentation/).
12+
* [Report Bugs or Issues](/contribute/bug-reporting-guide/) against the core libraries.
13+
* [Fix Bugs or Issues](/contribute/guide/) against the
1214
[reported library bugs/issues](https://issues.scala-lang.org/issues/?filter=13001).
1315
* Contribute significant new functionality or a new API by submitting
1416
a Scala Library Improvement Process (SLIP) Document.

contribute/documentation.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Documentation Contributions
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/documentation/
5+
includeTOC: true
46
---
57
## Contributing Documentation to the Scala project
68

@@ -20,11 +22,11 @@ Thanks
2022

2123
The Scala API documentation lives with the scala project source code. There are many ways you can help with improving Scaladoc, including:
2224

23-
* [Log issues for missing scaladoc documentation](./scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
25+
* [Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation/#contribute-api-documentation-bug-reports) -
2426
Please *follow the issue submission process closely* to help prevent duplicate issues being created.
25-
* [Claim Scaladoc Issues and Provide Documentation](./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.
27+
* [Claim Scaladoc Issues and Provide Documentation](/contribute/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.
2628
* You can also just
27-
[submit new Scaladoc](./scala-standard-library-api-documentation.html)
29+
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation/)
2830
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-internals so that people know what you are doing.
2931

3032
### The Main Scala Documentation Site

contribute/guide.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Contributing guide
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/guide/
5+
includeTOC: true
46
---
57

68
<div class="container">
@@ -10,7 +12,7 @@ title: Contributing guide
1012
<p>Get a peek into the inners of the Scala compiler.</p>
1113
</div>
1214
<div class="span4 doc-block">
13-
<h3><a href="{{ site.baseurl }}/contribute/bug-reporting-guide.html">Report an issue</a></h3>
15+
<h3><a href="{{ site.baseurl }}/contribute/bug-reporting-guide/">Report an issue</a></h3>
1416
<p>File a bug report or a feature request.</p>
1517
</div>
1618
</div>
@@ -21,7 +23,7 @@ title: Contributing guide
2123
<p>Get cracking on some easy to approach issues.</p>
2224
</div>
2325
<div class="span4 doc-block">
24-
<h3><a href="{{ site.baseurl }}/contribute/hacker-guide.html">Hacker's guide</a></h3>
26+
<h3><a href="{{ site.baseurl }}/contribute/hacker-guide/">Hacker's guide</a></h3>
2527
<p>Learn to write good code and improve your chances of contributing to the Scala galaxy.</p>
2628
</div>
2729
</div>
@@ -52,19 +54,19 @@ unencumbered by copyrights or patents.
5254

5355
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)
5456

55-
1. [Select a bug to fix from JIRA](/contribute/index.html#community-tickets), or if you found the bug yourself and want to fix it, [create a JIRA issue](./bug-reporting-guide.html) (but please
56-
[make sure it's not a duplicate](./bug-reporting-guide.html#reporting-confirmed-bugs-is-a-sin)).
57-
2. Optional ([but recommended](./scala-internals.html#why-its-a-good-idea)), announce your intention to work on the bug on [scala-internals](./scala-internals.html). After all, don't you want to work on a team with
58-
[these friendly people](./hacker-guide.html#connect) - it's one of the perks of contributing.
59-
3. [Fork the Scala repository](./hacker-guide.html#fork) and clone your fork (if you haven't already).
60-
4. [Create a feature branch](./hacker-guide.html#branch) to work on: use the branch name `issue/NNNN` where NNNN is the JIRA issue number.
61-
5. [Fix the bug, or implement the new small feature](./hacker-guide.html#implement), include new tests (yes, for bug fixes too).
62-
6. [Test, rinse](./hacker-guide.html#test) and [test some more](./partest-guide.html) until [all the tests pass](./hacker-guide.html#verify).
63-
7. [Commit your changes](./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.
57+
1. [Select a bug to fix from JIRA](/contribute/#community-tickets), or if you found the bug yourself and want to fix it, [create a JIRA issue](/contribute/bug-reporting-guide/) (but please
58+
[make sure it's not a duplicate](/contribute/bug-reporting-guide/#reporting-confirmed-bugs-is-a-sin)).
59+
2. Optional ([but recommended](/contribute/scala-internals/#why-its-a-good-idea)), announce your intention to work on the bug on [scala-internals](/contribute/scala-internals/). After all, don't you want to work on a team with
60+
[these friendly people](/contribute/hacker-guide/#connect) - it's one of the perks of contributing.
61+
3. [Fork the Scala repository](/contribute/hacker-guide/#fork) and clone your fork (if you haven't already).
62+
4. [Create a feature branch](/contribute/hacker-guide/#branch) to work on: use the branch name `issue/NNNN` where NNNN is the JIRA issue number.
63+
5. [Fix the bug, or implement the new small feature](/contribute/hacker-guide/#implement), include new tests (yes, for bug fixes too).
64+
6. [Test, rinse](/contribute/hacker-guide/#test) and [test some more](/contribute/partest-guide/) until [all the tests pass](/contribute/hacker-guide/#verify).
65+
7. [Commit your changes](/contribute/hacker-guide#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.
6466
8. If necessary [re-write git history](http://git-scm.com/book/en/Git-Branching-Rebasing) so that [commits are organized by major steps to the fix/feature](
6567
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)
6668
9. [Submit a pull request](./hacker-guide.html#submit) following the [Scala project pull-request guidelines](http://docs.scala-lang.org/scala/pull-request-policy.html).
67-
10. [Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](./hacker-guide.html#review).
69+
10. [Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/contribute/hacker-guide/#review).
6870
11. Celebrate!
6971

7072
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).
@@ -76,4 +78,4 @@ and on the implementation plan. Announce the change
7678
on the [scala-internals](http://groups.google.com/group/scala-internals) mailing list and get developer feedback. For really complex changes, a [Scala Improvement Process (SIP)](http://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.
7779

7880
Contributions, big or small, simple or complex, controversial or undisputed, need to materialize as patches against
79-
the Scala project source tree. The [hacker guide](hacker-guide.html) will explain how to materialize your idea into a full-fledged pull request against the Scala code base.
81+
the Scala project source tree. The [hacker guide](/contribute/hacker-guide/) will explain how to materialize your idea into a full-fledged pull request against the Scala code base.

contribute/hacker-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
layout: page
32
title: Scala hacker guide
43
by: Eugene Burmako
4+
layout: inner-page-no-masthead
5+
permalink: /contribute/hacker-guide/
6+
includeTOC: true
57
---
68
<br>
79
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.

contribute/index.md

Lines changed: 9 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Contribute
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/
5+
includeTOC: true
46
---
57

68
The Scala programming language is an open source project with a very
@@ -15,92 +17,22 @@ That depends on what you want to contribute. Below are some getting started reso
1517

1618
### Reporting bugs
1719

18-
See our [bug reporting guide](./bug-reporting-guide.html) to learn
20+
See our [bug reporting guide](/contribute/bug-reporting-guide/) to learn
1921
how to efficiently report a bug.
2022

2123
### Contribute
2224

2325
Coordination of contribution efforts takes place on the
24-
[scala-internals Google group](./scala-internals.html).
25-
26-
<div class="container">
27-
<div class="row">
28-
<div class="span4 doc-block">
29-
<h4><a href="./documentation.html">Documentation</a></h4>
30-
<p><a href="./scala-standard-library-api-documentation.html">Scaladoc (API)</a>,
31-
<a href="http://docs.scala-lang.org/contribute.html">docs.scala-lang.org</a> and
32-
<a href="https://github.com/scala/scala-lang">scala-lang.org</a>.</p>
33-
</div>
34-
<div class="span4 doc-block">
35-
<h4><a href="./guide.html">Bug Fixes</a></h4>
36-
<p>Issues with the tools, core libraries and compiler. Also you can help us by <a href="./bug-reporting-guide.html">reporting bugs</a></p>
37-
</div>
38-
</div>
39-
40-
<div class="row">
41-
<div class="span4 doc-block">
42-
<h4><a href="./codereviews.html">Code Reviews</a></h4>
43-
<p>Review pull requests against <a href="https://github.com/scala/scala/pulls">scala/scala</a>,
44-
<a href="https://github.com/scala/scala-lang/pulls">scala/scala-lang</a>,
45-
<a href="https://github.com/scala/scala.github.com/pulls">scala/scala.github.com</a> and others.</p>
46-
</div>
47-
<div class="span4 doc-block">
48-
<h4><a href="./corelibs.html">Core Libraries</a></h4>
49-
<p>Update and expand the capabilities of the core (and associated) Scala libraries.</p>
50-
</div>
51-
</div>
52-
53-
<div class="row">
54-
<div class="span4 doc-block">
55-
<h4><a href="./tools.html">IDE and Build Tools</a></h4>
56-
<p>Enhance the Scala tools with features for build tools, IDE plug-ins and other related projects.</p>
57-
</div>
58-
<div class="span4 doc-block">
59-
<h4><a href="./guide.html#larger-changes-new-features">Compiler/Language</a></h4>
60-
<p>Larger language features and compiler enhancements including language specification and SIPs.</p>
61-
</div>
62-
</div>
63-
</div>
26+
[scala-internals Google group](/contribute/scala-internals/).
27+
28+
{% include column-list-of-items.html collection=site.contribute_resources %}
6429

6530
### Community Tickets
6631

6732
The following links provide starting points for
6833
various contributor activities:
6934

70-
<div class="container">
71-
<div class="row">
72-
<div class="span4 doc-block">
73-
<h4><a href="https://issues.scala-lang.org/issues/?filter=13003">Documentation</a></h4>
74-
<p>Help augment or correct the documentation.</p>
75-
</div>
76-
<div class="span4 doc-block">
77-
<h4><a href="https://issues.scala-lang.org/issues/?filter=13001">Core Libraries</a></h4>
78-
<p>Community bugs and enhancements on the core libs.</p>
79-
</div>
80-
</div>
81-
82-
<div class="row">
83-
<div class="span4 doc-block">
84-
<h4><a href="https://issues.scala-lang.org/issues/?filter=13002">Tools</a></h4>
85-
<p>Help with the Scala tool chain.</p>
86-
</div>
87-
<div class="span4 doc-block">
88-
<h4><a href="https://issues.scala-lang.org/issues/?filter=13000">Compiler</a></h4>
89-
<p>Ready for a challenge? Here's the compiler bugs.</p>
90-
</div>
91-
</div>
92-
93-
<div class="row">
94-
<div class="span4 doc-block">
95-
<h4><a href="https://issues.scala-lang.org/issues/?filter=13004">Bugs</a></h4>
96-
<p>All bugs marked with the label <em>community</em>.</p>
97-
</div>
98-
<div class="span4 doc-block">
99-
<h4><a href="https://issues.scala-lang.org/issues/?filter=13009">All Issues</a></h4>
100-
<p>Bugs + Enhancements marked with the label <em>community</em>.</p>
101-
</div>
102-
</div>
103-
</div>
35+
{% include column-list-of-items.html collection=site.contribute_community_tickets %}
10436

10537
### Tools and Libraries
10638

@@ -109,7 +41,7 @@ with their own maintainers and community of contributors. Helping out
10941
one of these projects is another way to help Scala. Consider lending
11042
on a hand on a project you're already using. Or, to find out about
11143
other projects, see the
112-
[Libraries and Tools section](../community/index.html#community-libraries-and-tools)
44+
[Libraries and Tools section](/community/#community-libraries-and-tools)
11345
on our Community page.
11446

11547
### Scala Community Build

contribute/partest-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Running the Test Suite
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/partest-guide/
5+
includeTOC: true
46
---
57

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

contribute/scala-internals.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Scala Internals Mailing List
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/scala-internals/
5+
includeTOC: true
46
---
57

68
## scala-internals

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
layout: page
32
title: Contribute to API Documentation
3+
layout: inner-page-no-masthead
4+
permalink: /contribute/scala-standard-library-api-documentation/
5+
includeTOC: true
46
---
57

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

0 commit comments

Comments
 (0)