Skip to content

Commit 0331a90

Browse files
committed
Add Add new project section to the readme
Credits go to @olafurpg for his comment in scala/scala3#2182
1 parent 660aee1 commit 0331a90

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# Dotty Community Build
22
[![Community Build Status](https://travis-ci.org/lampepfl/dotty-community-build.svg?branch=master)](https://travis-ci.org/lampepfl/dotty-community-build)
33

4-
54
This repository contains tests to build a corpus of Scala open sources projects
65
against the latest changes in Dotty.
76

87
To run the community build on a local machine, clone the repo and execute `./run.sh`.
98

109
The tests will by default run against the latest NIGHTLY build of dotty.
1110
To customize the dotty version, set the environment variable `export DOTTY_VERSION=X.Y.Z`.
11+
12+
## Adding a new project
13+
To add a new project `ORG/REPO` to the community build you can follow this steps:
14+
1. Fork `ORG/REPO` to `dotty-staging/REPO`
15+
2. Clone `dotty-staging/REPO`, create a branch `dotty` and push the `dotty` branch
16+
3. Open `dotty-staging/REPO` on Github. Go to `Settings > Branches`. Change the default branch to `dotty`
17+
4. Go to https://travis-ci.org/profile/dotty-staging and enable that repo. You may need to click on `Sync account` and
18+
reload to see the newly forked repo
19+
5. Fork the `dotty-staging/REPO` to your personal github account
20+
6. Edit the build to use `sbt-dotty` and fix all the compilation errors. Example PRs:
21+
- https://github.com/dotty-staging/scalacheck/pull/1
22+
- https://github.com/dotty-staging/squants/pull/1
23+
- https://github.com/dotty-staging/algebra/pull/1
24+
7. Once the project complies with dotty, copy the `.travis.yml` file from
25+
[here](https://github.com/dotty-staging/squants/blob/37ea54761b5e80ddc0dfc273fc4bbad430f201f5/.travis.yml#L3)
26+
and adjust the compile task. I'm only compiling projects for now, not running any tests.
27+
Just making sure that the projects compiles is a great start
28+
8. Open PR to merge your changes into the `dotty` branch of hte `dotty-staging/REPO`
29+
9. Once PR is merged into `dotty-staging/REPO`, open a PR to `lampepfl/dotty-community-build` adding the new
30+
`dotty-staging/REPO` to the community build. Example PR: https://github.com/lampepfl/dotty-community-build/pull/3

0 commit comments

Comments
 (0)