Skip to content

Commit

Permalink
Add docs about working locally to the contributing doc (#82)
Browse files Browse the repository at this point in the history
Co-authored-by: hatz <[email protected]>
  • Loading branch information
cloud-janitors-figure and ahatzz11 authored Feb 21, 2023
1 parent c1deaae commit 033c9dd
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@
We are always looking for bug fixes, changes, and new features.
If you'd like to work on something please consider making an issue to help track what is being worked on, but someone from the Figure team will be around to help review code and approve pull requests!

## Working Locally

To build locally:

```
./gradlew clean build
```

To publish locally we recommend commenting out the `signing` plugin, located in the `build-logic/build-conventions/src/main/kotlin/local.publishing.gradle.kts`.
This stops the signing from happening on a publish locally so you don't need to mess around with keys.
Then you can run:

```
./gradlew publishToMavenLocal
```

## Tests

Currently we don't have a lot of tests, but we do have one set up that uses the `GradleRunner` to create a gradle environment just for the test that we can then apply our code to and run tasks.
Check out the `BuildLogicFunctionalSpec` to see how this works.

## Licensing

One thing we need to ensure is that we maintain a license header on each source file.
Expand Down

0 comments on commit 033c9dd

Please sign in to comment.