@@ -21,8 +21,9 @@ contribution steps and guidelines. Thank you.*
21
21
Since API documentation is located in Scala source code files, the
22
22
process for contributing API documentation is similar to that of contributing bug-fixes
23
23
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,
26
27
instead.
27
28
28
29
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,
35
36
36
37
One good way to contribute is by helping us to identify missing documentation. To do
37
38
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
40
41
and are a good place for API overviews).
41
42
42
43
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.
74
75
Please familiarize yourself with ** all** of the following before contributing
75
76
new API documentation to save time, effort, mistakes and repetition.
76
77
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 `
79
80
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.
82
82
* [ Scaladoc for library authors] ( http://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html )
83
83
covers the use of scaladoc tags, markdown and other features.
84
84
* [ Scaladoc's interface] ( http://docs.scala-lang.org/overviews/scaladoc/interface.html )
0 commit comments