Skip to content

Commit 75efc9d

Browse files
committed
Merge pull request scala#262 from JustinPihony/scaladoc/updatecontrib
Fix the Forking url and grammatical consistency
2 parents c605c2e + 66f39d2 commit 75efc9d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ contribution steps and guidelines. Thank you.*
2121
Since API documentation is located in Scala source code files, the
2222
process for contributing API documentation is similar to that of contributing bug-fixes
2323
to the Scala code base, but without the requirement that there be an issue filed on JIRA
24-
first (when forking/branching, just use a `scaladoc/xxxx` branch name instead of `issue/NNNN`).
25-
However, if an issue *does* exist, please use `issue/NNNN` (where NNNN is the ticket number)
24+
first. When forking/branching, just use a `scaladoc/xxxx` branch name, where xxxx is a
25+
descriptive, but short branch name (e.g. `scaladoc/future-object`).
26+
However, if an issue *does* exist, please use `issue/NNNN`, where NNNN is the ticket number,
2627
instead.
2728

2829
If you would like to assist us by helping us find missing documentation and
@@ -35,8 +36,8 @@ If you want to contribute new API documentation,
3536

3637
One good way to contribute is by helping us to identify missing documentation. To do
3738
this, [browse the current API documentationn](http://www.scala-lang.org/api/current/)
38-
and identify missing, incorrect or inadequate documentation. A good place to start is
39-
is package objects for important packages (these often get overlooked for documentation
39+
and identify missing, incorrect or inadequate documentation. A good place to start is
40+
package objects for important packages (these often get overlooked for documentation
4041
and are a good place for API overviews).
4142

4243
If you find an issue, please log it in the [Scala issue tracker](https://issues.scala-lang.org)
@@ -74,11 +75,10 @@ component so that they show up in the correct issue filters.
7475
Please familiarize yourself with **all** of the following before contributing
7576
new API documentation to save time, effort, mistakes and repetition.
7677

77-
* [Forking the Repo](./hacker-guide.html#set-up) follow setup steps through
78-
branch name. If providing new documentation related to an existing JIRA issue, use `issue/NNNN`
78+
* [Forking the Repo](./hacker-guide.html#2_set_up) - follow the setup steps through
79+
the Branch section. If providing new documentation related to an existing JIRA issue, use `issue/NNNN`
7980
or `ticket/NNNN` as the guide states. If providing API documentation with no associated
80-
JIRA issue, use `scaladoc/xxxx` instead, where xxxx is a descriptive but
81-
short branch name, e.g. `scaladoc/future-object`.
81+
JIRA issue, use `scaladoc/xxxx` instead.
8282
* [Scaladoc for library authors](http://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html)
8383
covers the use of scaladoc tags, markdown and other features.
8484
* [Scaladoc's interface](http://docs.scala-lang.org/overviews/scaladoc/interface.html)

0 commit comments

Comments
 (0)