Skip to content

Commit 47ef2b7

Browse files
authored
Merge pull request #10549 from SethTisue/readme-merge
merge CONTRIBUTING.md into README.md
2 parents dffa948 + 85b51c7 commit 47ef2b7

File tree

2 files changed

+41
-40
lines changed

2 files changed

+41
-40
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,40 @@
1-
Thank you for reporting a bug with the Scala compiler or standard library. We're sorry for the trouble it caused!
1+
# Welcome to the Scala compiler & standard library bug tracker!
22

3-
Some reporting guidelines that help us fix your bug faster:
4-
- provide a brief yet actionable description, such as
5-
> I tried [code snippet], the compiler said [error]. I think this should compile because [it used to work on older version X].
6-
- include the Scala version(s) you tried, and the version of the JVM you're using
7-
- make sure it's a new bug :smirk:
3+
## Scope of this tracker
84

9-
This is the right place to report a bug in the compiler or the standard library.
10-
For language design discussions, please consult the [README](README.md) for better venues.
5+
This is the right place to report a bug or a minor shortcoming in the Scala compiler, standard library, and language specification.
116

12-
On this tracker, we care especially about:
13-
- regressions
14-
- unintuitive error messages or unclear documentation
15-
- programs that [should | should not] compile but [do not| do]
16-
- unexpected behavior in the library
7+
To keep this tracker focused, we ask that feature requests and discussion of potential language changes take place in the [language design](https://contributors.scala-lang.org/c/language-design) category on our contributors forum.
178

18-
Bug reports with a small, self-contained code snippet tend to get fixed faster.
19-
Of course reports without a small reproduction are accepted too -- we know minimizing a bug can be tricky.
9+
## Before opening an issue
10+
11+
Thank you for finding a bug. We're sorry for the trouble it caused!
12+
13+
Before opening an issue here, please:
14+
15+
1. do a search to make sure it's a new bug
16+
2. use a small, self-contained snippet of Scala code to illustrate what happened, and contrast with what you expected the compiler to say or the library to do;
17+
3. include the Scala version(s) you've tried, and the version of the JVM you're using.
18+
19+
A bug report without a small, self-contained code snippet is much less likely to receive attention.
20+
21+
## Assistance from the community
22+
23+
If you're not sure whether your issue is a bug, we are happy to help at:
24+
25+
- [the Scala Users forum](https://users.scala-lang.org/);
26+
- [the scala/scala Gitter room](https://gitter.im/scala/scala);
27+
- [questions tagged with #scala on Stack Overflow](http://stackoverflow.com/questions/tagged/scala).
28+
29+
## Help with contributing fixes
30+
31+
We are happy to help you with your contribution via:
32+
33+
- [the Scala Contributors forum](https://contributors.scala-lang.org/);
34+
- [the scala/contributors Gitter room](https://gitter.im/scala/contributors);
35+
- [our "Get Ready to Contribute" guide](https://github.com/scala/scala/#get-ready-to-contribute);
36+
- [our "Scala Hacker" guide](http://scala-lang.org/contribute/hacker-guide.html).
37+
38+
## About
39+
40+
The first 10250 issues in this tracker were [imported](https://github.com/adriaanm/bbj) from [JIRA](https://issues.scala-lang.org?orig=1). We made every attempt to preserve all data and metadata that's supported by the GitHub import API. Sadly, the author metadata could not be preserved directly.

README.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,9 @@
1-
# Welcome to the Scala compiler & standard library bug tracker!
1+
# Welcome to the core Scala bug tracker!
22

3-
## Before opening an issue
3+
## What belongs here?
44

5-
Before opening an issue to report a bug in the Scala compiler or standard library, please:
6-
1. do a quick search to make sure it's a new bug;
7-
2. use a small, self-contained snippet of Scala code to illustrate what happened, and contrast with what you expected the compiler to say or the library to do;
8-
3. include the Scala version(s) you've tried, and the version of the JVM you're using.
5+
This is the right place to report a bug or a minor shortcoming in the Scala compiler, standard library, and language specification.
96

10-
## Assistance from the community
7+
To keep this tracker focused, we ask that feature requests and discussion of potential language changes take place in the [language design](https://contributors.scala-lang.org/c/language-design) category on our contributors forum.
118

12-
If you're not sure whether your issue is a bug, we are happy to help at:
13-
- [the Scala Users forum](https://users.scala-lang.org/);
14-
- [the scala/scala Gitter room](https://gitter.im/scala/scala);
15-
- [questions tagged with #scala on Stack Overflow](http://stackoverflow.com/questions/tagged/scala).
16-
17-
To keep this tracker focused on bugs and small improvements, we ask that you first discuss language changes and other, bigger, feature requests in the [language design](https://contributors.scala-lang.org/c/language-design) category on our contributors forum.
18-
19-
## Help with contributing fixes
20-
21-
We are happy to help you with your contribution via:
22-
- [the Scala Contributors forum](https://contributors.scala-lang.org/);
23-
- [the scala/contributors Gitter room](https://gitter.im/scala/contributors);
24-
- [our "Get Ready to Contribute" guide](https://github.com/scala/scala/#get-ready-to-contribute);
25-
- [our "Scala Hacker" guide](http://scala-lang.org/contribute/hacker-guide.html).
26-
27-
## About
28-
29-
The first 10250 issues in this tracker were [imported](https://github.com/adriaanm/bbj) from [JIRA](https://issues.scala-lang.org?orig=1). We made every attempt to preserve all data and metadata that's supported by the GitHub import API. Sadly, the author metadata could not be preserved directly.
9+
For further bug reporting guidelines, see [CONTRIBUTING.md](https://github.com/scala/bug/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)