You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,40 @@ provides a few new features:
7
7
1. A small Java library for integrating MarkLogic unit tests into existing test frameworks like JUnit
8
8
1. The ability to depend on this module as a true third-party dependency via ml-gradle
9
9
10
-
To try this out locally, check out the [ml-gradle example project](https://github.com/marklogic-community/ml-gradle/tree/dev/examples/unit-test-project).
10
+
To try this out locally, check out the
11
+
[ml-gradle example project](https://github.com/marklogic-community/ml-gradle/tree/dev/examples/unit-test-project).
11
12
You can use that project's build.gradle file as an example of how to use marklogic-unit-test in your own project.
12
13
14
+
# Contributing
15
+
16
+
Contributions are welcome. Here are some steps to get you started:
17
+
1. Please start by forking the project on GitHub
18
+
1. Check out your fork of the project
19
+
1. Make your changes
20
+
1. Add tests to cover your changes
21
+
1. Make sure the tests pass by running `gradle build test`
22
+
1. Check in your changes to your fork on GitHub
23
+
1. Once the changes are ready, create a pull request
24
+
1. Wait for the pull request to be reviewed and accepted into the baseline
25
+
26
+
## Testing
27
+
Please make sure that all changes to the project include sufficient unit tests to cover the feature being added. Pull
28
+
requests without automated tests will not be accepted.
29
+
30
+
Tests can be added to `{PROJECT}/marklogic-unit-test-client/src/test/ml-modules/root/test/suites` and can be ran with
31
+
the `gradle build test` target.
32
+
33
+
If you're using an IDE with Junit support tests can be ran from the IDE by running the test at
1. Increment the `version` property in `{PROJECT}/gradle.properties`
18
41
2. In `{PROJECT}/`, run `github_changelog_generator --token $your-github-token --future-release v1.0.0`
19
-
- If running on Windows, you'll need to use different cache file paths, such as `--cache-file C:\tmp\github-changelog-http-cache --cache-log C:\tmp\github-changelog-logger.log`.
42
+
- If running on Windows, you'll need to use different cache file paths, such as
0 commit comments