Skip to content

Commit

Permalink
Adding some basic development setup information. (#2938)
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel-Khodabakhsh authored Nov 10, 2022
1 parent bcdd71c commit 6b730bb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ You may also check out these [other resources](https://akka.io/get-involved/).

# Contributing to Alpakka

## Development Setup

Ensure to install the following dependencies:

- [Git](https://git-scm.com/) (Make sure the `git` executable is referenced in the `PATH` environment variable)
- Having `git` in the `PATH` is important because it is used by the MiMa plugin when loading the sbt project.
- Java JDK
- [SBT](https://www.scala-sbt.org/) which can be installed standalone, or bundled with [Scala](https://scala-lang.org/) or IDEs such as [IntelliJ IDEA](https://www.jetbrains.com/idea/).

When cloning or updating the repository, make sure to clone/fetch/pull in a way which gets the git tags (such as a regular `git clone`, `git fetch` or `git pull`).
This is needed because the MiMa plugin checks the git history and tags when loading the sbt project.
Doing a shallow clone/fetch/pull will not get the tag information and will interfere with the project loading process.

## General Workflow

This is the process for committing code into master.
Expand Down

0 comments on commit 6b730bb

Please sign in to comment.