Skip to content

community build readme tweaks #13255

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.

Sign up for GitHub

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 2 commits into from
Aug 5, 2021
Merged

community build readme tweaks #13255

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50b8ab9
community build readme: Dotty -> Scala 3
SethTisue Aug 4, 2021
19ab68f
community build readme: how to run a single project
SethTisue Aug 4, 2021
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
12 changes: 8 additions & 4 deletions community-build/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Dotty Community Build
# Scala 3 Community Build

This project contains tests to build and test a corpus of open sources Scala projects against the latest version of Dotty.
This project contains tests to build and test a corpus of open sources Scala projects against the latest version of Scala 3.

## Running it locally

To run the community build on a local machine, first fetch all the git submodules with `git submodule update --init` and run `sbt community-build/test` from the root of the dotty repo.

To run a single project, you can use the usual syntax for running a single JUnit test, for example `community-build/testOnly -- *shapeless`

## Adding your project

To add your project to the community build you can follow these steps:

1. Get your project to compile with Dotty. Instructions can be found on the [dotty-example-project](https://github.com/lampepfl/dotty-example-project).
See the submodules in [community-projects](https://github.com/lampepfl/dotty/tree/master/community-build/community-projects/) for examples of projects that compile with Dotty.
1. Get your project to compile with Scala 3. Instructions can be found on the [scala3-example-project](https://github.com/lampepfl/scala3-example-project).
See the submodules in [community-projects](https://github.com/lampepfl/dotty/tree/master/community-build/community-projects/) for examples of projects that compile with Scala 3.

2. Open a PR against this repo that:
- Adds your project as a new git submodule
Expand Down