Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.
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
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contribute

We are glad to see your pull requests.

We use Travis as our continous integration build. Because of Travis security reasons on a Pull Request only JUnit tests run.
The integration tests need a valid AIRTABLE_API_KEY which travis doesent provide on PR's from forked reposiorys.
However the integration tests you wrote will run after the PR is confirmed and merged.

## Current status

The current status of our project is maintained on our agile board:
[Kanban Board of airtable.java](https://github.com/Sybit-Education/airtable.java/projects/1)

## Compiling project

airtable.jave is developed and compiled using Java 8.


We use [Gradle](https://gradle.org) to compile and package project:

+ for tests run: `./gradlew clean test`
+ build jar: `./gradlew jar` (The built JARs will be placed under `build/libs`.)

## Testing

There are JUnit tests and integration tests to verify the API.
The integration tests are based on the Airtable template [Movies](https://airtable.com/templates/groups-clubs-and-hobbies/exprTnrH3YV8Vv9BI/favorite-movies) which could be created in your account.
For testing, the JSON-responses are mocked by [WireMock](http://wiremock.org/).
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,26 +349,7 @@ Short overview of features, which are supported:

# Contribute

We are glad to see your pull requests.

We use Travis as our continous integration build. Because of Travis security reasons on a Pull Request only JUnit tests run.
The integration tests need a valid AIRTABLE_API_KEY which travis doesent provide on PR's from forked reposiorys.
However the integration tests you wrote will run after the PR is confirmed and merged.

## Current status

The current status of our project is maintained on our agile board:
[Kanban Board of airtable.java](https://github.com/Sybit-Education/airtable.java/projects/1)

## Compiling project

airtable.jave is developed and compiled using Java 8.


We use [Gradle](https://gradle.org) to compile and package project:

+ for tests run: `./gradlew clean test`
+ build jar: `./gradlew jar` (The built JARs will be placed under `build/libs`.)
see: [CONTRIBUTING.md](./CONTRIBUTING.md)

## Testing

Expand Down