Skip to content
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

Jump to bottom

Update CONTRIBUTING.md with the new build guide #2600

Merged
merged 11 commits into from Jan 7, 2022
Merged

Update CONTRIBUTING.md with the new build guide #2600

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
20de09d
Update CONTRIBUTING.md with the new build guide
lukaszkalnik Dec 17, 2021
e89e526
Add info how to get subprojects list; improve layout
lukaszkalnik Dec 18, 2021
a5e920b
Update info on building the documentation
lukaszkalnik Dec 20, 2021
55803ca
Update how to create a pull request with required code formatting and…
lukaszkalnik Dec 20, 2021
b4e4b07
Remove references to Ank
lukaszkalnik Dec 20, 2021
ee6502e
Update Gradle upgrading guide
lukaszkalnik Dec 20, 2021
04cdcb5
Correct file extensions for adding new module
lukaszkalnik Dec 20, 2021
3b80b51
Extend info on API binary compatibility check
lukaszkalnik Dec 25, 2021
9ca2f07
Mention generating Knit code examples as necessary build step
lukaszkalnik Dec 29, 2021
fd3d303
Merge branch 'main' into update-contributing-guide
lukaszkalnik Jan 2, 2022
571dd28
Improve wording of Knit usage description
lukaszkalnik Jan 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Expand Up @@ -32,20 +32,18 @@ Can't find what you're looking for? Please, contact us at [#arrow on Kotlin Slac

### Steps

To build all the libraries (compilation + tests) and examples:
To build all the libraries (compilation + tests) and examples run in the project root (`arrow` directory):

```bash
cd arrow-libs
./gradlew build
```

To build just CORE libraries, FX libraries, OPTICS libraries, etc. select the correspondent directory.
To build just CORE libraries, FX libraries, OPTICS libraries etc. run the corresponding [subproject's](https://docs.gradle.org/current/userguide/intro_multi_project_builds.html#sec:executing_tasks_by_fully_qualified_name) `build` task.

For instance, for CORE libraries:

```bash
cd arrow-libs/core
./gradlew build
./gradlew :arrow-core:build
```

## How to generate and validate the documentation
Expand Down