Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,19 @@ Suggestions for improvements are also logged as [GitHub Issues](https://github.c

1. Fork the repository and clone it locally.
2. Create a branch for your edit: `git checkout -b my-new-feature`.
3. Make your changes and commit: `git commit -m 'feat: Adds new feature'`.
3. Make your changes and commit: `git commit -m 'feat: add some feature'`.
4. Push to the original branch: `git push origin my-new-feature`.
5. Create a Pull Request.

### Before Submitting a PR

To ensure your code follows the project's standards and passes the CI pipeline, please run the following commands before submitting your Pull Request.

#### Tests

- We must use assertj library (we use it already in the project) for assertions.
- The test naming must be `should_expectedBehavior_when_stateUnderTest` example: `should_throwException_when_ageLessThan18`.

#### Backend (Java/Quarkus)

Run the following command to clean, format, and package the application:
Expand Down
38 changes: 24 additions & 14 deletions timeless-api/pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>dev.matheuscruz</groupId>
<artifactId>timeless-api</artifactId>
Expand All @@ -19,6 +20,7 @@
<quarkus-quinoa.version>2.5.4</quarkus-quinoa.version>
<jbcrypt.version>0.4</jbcrypt.version>
<quarkus-langchain4j-openai.version>1.0.0.CR1</quarkus-langchain4j-openai.version>
<assertj.version>3.27.6</assertj.version>
</properties>

<dependencyManagement>
Expand Down Expand Up @@ -66,16 +68,6 @@
<artifactId>quarkus-quinoa</artifactId>
<version>${quarkus-quinoa.version}</version>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>rest-assured</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.quarkiverse.langchain4j</groupId>
<artifactId>quarkus-langchain4j-openai</artifactId>
Expand Down Expand Up @@ -114,6 +106,23 @@
<groupId>io.quarkus</groupId>
<artifactId>quarkus-scheduler</artifactId>
</dependency>
<!-- test dependencies -->
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<version>${assertj.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>rest-assured</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down Expand Up @@ -164,7 +173,8 @@
</executions>
<configuration>
<systemPropertyVariables>
<native.image.path>${project.build.directory}/${project.build.finalName}-runner
<native.image.path>
${project.build.directory}/${project.build.finalName}-runner
</native.image.path>
<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
<maven.home>${maven.home}</maven.home>
Expand Down Expand Up @@ -214,4 +224,4 @@
</properties>
</profile>
</profiles>
</project>
</project>