Skip to content

Contributing.md

Latest commit

 

History

History
83 lines (57 loc) · 2.08 KB

Contributing.md

File metadata and controls

83 lines (57 loc) · 2.08 KB
Raw
Title Contributing
Author Jonathan Zollinger
Date January 16 2024
Comment It's expected that these instructions are edited with each repo, namely - prerequisites - any mention of threshr - variations from maven 3.8.6, graal, or java version 17.0.8

Contributing

By participating in this project, you agree to abide our code of conduct.

Set up your machine

threshr is written in Java using Oracle's GraalVM and uses Maven as its build tool

Prerequisites:

Other things you might need to run the tests:

Create your own fork of threshr, then clone your fork anywhere:

git clone git@github.com:Graqr/Threshr.git

cd into the directory and install the dependencies:

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.

See our style guide for supported coding practices.

Test your change

Adequate acceptance testing is to be included with pull requests for new code. See our style guide for our testing standards.

mvn clean test

Validate threshr builds

mvn clean install

Create a commit

Commit messages should be well formatted and conform to [Conventional Commits].

Submit a pull request

Push your branch to your threshr fork and open a pull request against the original threshr main branch.