Skip to content

merge CONTRIBUTING.md into README.md #10549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 12, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 36 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
Thank you for reporting a bug with the Scala compiler or standard library. We're sorry for the trouble it caused!
# Welcome to the Scala compiler & standard library bug tracker!

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

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

On this tracker, we care especially about:
- regressions
- unintuitive error messages or unclear documentation
- programs that [should | should not] compile but [do not| do]
- unexpected behavior in the library
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.

Bug reports with a small, self-contained code snippet tend to get fixed faster.
Of course reports without a small reproduction are accepted too -- we know minimizing a bug can be tricky.
## Before opening an issue

Thank you for finding a bug. We're sorry for the trouble it caused!

Before opening an issue here, please:

1. do a search to make sure it's a new bug
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;
3. include the Scala version(s) you've tried, and the version of the JVM you're using.

A bug report without a small, self-contained code snippet is much less likely to receive attention.

## Assistance from the community

If you're not sure whether your issue is a bug, we are happy to help at:

- [the Scala Users forum](https://users.scala-lang.org/);
- [the scala/scala Gitter room](https://gitter.im/scala/scala);
- [questions tagged with #scala on Stack Overflow](http://stackoverflow.com/questions/tagged/scala).

## Help with contributing fixes

We are happy to help you with your contribution via:

- [the Scala Contributors forum](https://contributors.scala-lang.org/);
- [the scala/contributors Gitter room](https://gitter.im/scala/contributors);
- [our "Get Ready to Contribute" guide](https://github.com/scala/scala/#get-ready-to-contribute);
- [our "Scala Hacker" guide](http://scala-lang.org/contribute/hacker-guide.html).

## About

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.
30 changes: 5 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,9 @@
# Welcome to the Scala compiler & standard library bug tracker!
# Welcome to the core Scala bug tracker!

## Before opening an issue
## What belongs here?

Before opening an issue to report a bug in the Scala compiler or standard library, please:
1. do a quick search to make sure it's a new bug;
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;
3. include the Scala version(s) you've tried, and the version of the JVM you're using.
This is the right place to report a bug or a minor shortcoming in the Scala compiler, standard library, and language specification.

## Assistance from the community
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.

If you're not sure whether your issue is a bug, we are happy to help at:
- [the Scala Users forum](https://users.scala-lang.org/);
- [the scala/scala Gitter room](https://gitter.im/scala/scala);
- [questions tagged with #scala on Stack Overflow](http://stackoverflow.com/questions/tagged/scala).

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.

## Help with contributing fixes

We are happy to help you with your contribution via:
- [the Scala Contributors forum](https://contributors.scala-lang.org/);
- [the scala/contributors Gitter room](https://gitter.im/scala/contributors);
- [our "Get Ready to Contribute" guide](https://github.com/scala/scala/#get-ready-to-contribute);
- [our "Scala Hacker" guide](http://scala-lang.org/contribute/hacker-guide.html).

## About

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.
For further bug reporting guidelines, see [CONTRIBUTING.md](https://github.com/scala/bug/blob/master/CONTRIBUTING.md).