Skip to content

Commit 502d535

Browse files
Update doc & Remove GitHub rule usage
since rules are split accross multiple files it's not possible to use GitHub to publish te rule. We need to publish on maven central: scala#73
1 parent 610712f commit 502d535

File tree

2 files changed

+5
-13
lines changed

2 files changed

+5
-13
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ Even better, instead of providing a diff, you can directly add it as a test case
3131

3232
2. Add a file in the `scalafix/input/src/main/scala/fix/` directory with code
3333
that uses the standard collections:
34-
34+
3535
~~~ scala
3636
class toIteratorVsIterator(xs: Iterable[Int]) {
3737
xs.toIterator
3838
}
3939
~~~
4040

41-
3. Add a corresponding file in the `scalafix/output/src/main/scala/fix/` directory
41+
3. Add a corresponding file in the `scalafix/output213/src/main/scala/fix/` directory
4242
with the same code but using the strawman:
43-
43+
4444
~~~ scala
4545
import strawman.collection.Iterable
4646

@@ -51,7 +51,7 @@ class toIteratorVsIterator(xs: Iterable[Int]) {
5151

5252
4. Check that your code example compiles
5353
- run sbt from the `scalafix/` directory
54-
and then run the following tasks `; input/compile ; output/compile`;
54+
and then run the following task `compile`;
5555

5656
5. Commit your changes, push your branch to your fork and create a pull request.
5757

@@ -72,6 +72,6 @@ expected output files:
7272
~~~
7373

7474
Fix the implementation of the rule (in the
75-
`rules/src/main/scala/fix/Scalacollectioncompat_v0.scala` file) until the
75+
`rules/src/main/scala/fix/NewCollections.scala` file) until the
7676
tests are green. You can find more help about the scalafix API in its
7777
[documentation](https://scalacenter.github.io/scalafix/docs/rule-authors/setup).

README.md

-8
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,3 @@ The migration tool is not exhaustive and we will continue to improve
4848
it over time. If you encounter a use case that’s not supported, please
4949
report it as described in the
5050
[contributing documentation](CONTRIBUTING.md#migration-tool).
51-
52-
### Migrating a 2.12 code base to 2.13
53-
54-
Run the following sbt task on your project:
55-
56-
~~~
57-
> scalafix github:scala/scala-collection-compat/Stable
58-
~~~

0 commit comments

Comments
 (0)