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

Adding some basic development setup information. #2938

Merged
merged 5 commits into from
Nov 10, 2022
Merged

Adding some basic development setup information. #2938

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a112dff
Adding some basic development setup information.
Daniel-Khodabakhsh Nov 9, 2022
844f356
Add importance note to explain why `git` is needed in the `PATH`.
Daniel-Khodabakhsh Nov 9, 2022
c46c681
Add note for making sure tags have been pulled from git.
Daniel-Khodabakhsh Nov 9, 2022
6908758
Reword note on cloning/fetching/pulling the repository tags.
Daniel-Khodabakhsh Nov 9, 2022
1b2585c
Address PR comments by fixing Scala <-> SBT requirement.
Daniel-Khodabakhsh Nov 10, 2022
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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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