Skip to content

Commit

Permalink
feature(docs): add Contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan-Zollinger committed Oct 10, 2023
1 parent a1976e2 commit 7143133
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 114 deletions.
60 changes: 60 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Contributing

By participating in this project, you agree to abide our
[code of conduct](CODE_OF_CONDUCT.md).

## Set up your machine

`tarvester` is written in [Java](https://www.azul.com/modern-cloud-enterprise/) using Oracle's [GraalVM](https://github.com/oracle/graal) and uses [Maven](https://maven.apache.org/what-is-maven.html) to handle dependencies.

Prerequisites:

- [Java 17.0.8](https://sdkman.io/jdks#graalvm) in graal's flavor Graal (community edition)
- [Maven 3.8.6](https://maven.apache.org/install.html)

Other things you might need to run the tests:

- [Docker](https://www.docker.com/)

[//]: # (TODO: add docker configuration)

Create your own fork of `tarvester`, then clone your fork anywhere:

```shell
git clone git@github.com:<Seymoure-Butts>/tarvester.git
```

`cd` into the directory and install the dependencies:

```shell
mvn clean compile
```

## Branch off of main

It's a good practice not to put your changes in the main branch. Branch naming conventions aren't enforced, but I
personally like naming my branches with a `tag`/`task` convention. See [Create a commit](#create-a-commit).

See our [style guide](StyleGuide.md) for supported coding practices.
## Test your change

Adequate acceptance testing is to be included with pull requests for new code. See our [style guide](StyleGuide.md#Testing) for our testing standards.

```sh
mvn clean test
```

## Validate `tarvester` builds

```sh
mvn clean install
```


## Create a commit

Commit messages should be well formatted and conform to [Conventional Commits](https://www.conventionalcommits.org).

## Submit a pull request

Push your branch to your `tarvester` fork and open a pull request against the original `tarvester` main branch.
114 changes: 0 additions & 114 deletions Style Guide.md

This file was deleted.

0 comments on commit 7143133

Please sign in to comment.