Skip to content

Commit 0f8780c

Browse files
committed
Add contributing task guide
1 parent 3269197 commit 0f8780c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,24 @@ Then, point to the local repository in the configuration of either
2121

2222
## Contribute Metadata
2323

24+
The suggested way to contribute to Reachability metadata repository is by using the `contributing` task.
25+
Before you start the task, you should have your tests implemented somewhere locally on your machine (please verify that tests are working on Java).
26+
27+
In order to start this task, run (we suggest using `--console=plain` to reduce amount of gradle logging):
28+
29+
```shell
30+
./gradlew contribute --console=plain
31+
```
32+
33+
When started, the task will ask you few simple questions (like: where are your tests implemented, do your tests need resources, do your tests need docker images...).
34+
In case you don't understand the question, just type "help".
35+
36+
After it collects your answers, the task will:
37+
- generate necessary infrastructure
38+
- copy your tests to the proper location
39+
- generate metadata and store it in the proper location
40+
- ask you if you want to create a pull request, or you want to keep working on it locally
41+
2442
### Checklist
2543
In order to ensure that all contributions follow the same standards of quality we have devised a following list of requirements for each new added library.
2644
`org.example:library` project is also included as a template for new libraries.

0 commit comments

Comments
 (0)