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: CONTRIBUTING.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ To get started with development, follow the below steps.
57
57
58
58
_If you're using Windows, run the shell scripts using `GIT bash` - Windows-based bash command line._
59
59
60
-
**Caution**: If you are using jetBrains DataGrip, don't use the ingegrated console to run the shell scripts (not even with GIT bash configured). It might disconnect from oracle randomly during script-run.
60
+
**Caution**: If you are using jetBrains DataGrip, don't use the integrated console to run the shell scripts (not even with GIT bash configured). It might disconnect from oracle randomly during script-run.
61
61
62
62
### Clone your fork of utPLSQL git repository
63
63
@@ -94,13 +94,13 @@ export ORACLE_PWD=oracle # Adjust your local SYS password
94
94
95
95
The below script is fetching latest release version from utPLSQL repository. Latest release version is used for self-testing.
96
96
```bash
97
-
development/refresh_sources.sh
97
+
./development/refresh_sources.sh
98
98
```
99
99
100
100
### Setup local database for utPLSQL development
101
101
102
102
```bash
103
-
development/install.sh
103
+
./development/install.sh
104
104
```
105
105
106
106
### That's it
@@ -135,18 +135,18 @@ Whenever a new version of utPLSQL or a new version of utPLSQL-cli is available,
135
135
136
136
utPLSQL v3 unit tests are located in the `test` directory
137
137
138
-
Before you push any changes and create a pull request to the utPLSQL project repository, make sure that all of the tests are executing successfully in your local environment.
138
+
Before you push any changes and create a pull request to the utPLSQL project repository, make sure that all the tests are executing successfully in your local environment.
139
139
140
-
Every new functionality needs to be documented by unit tests that cover both happy-path scenarios as well as edge-cases and exception paths.
140
+
Every new functionality needs to be documented by unit tests that cover happy-path scenarios as well as edge-cases and exception paths.
141
141
142
142
> **Important notice:**
143
143
> We do our best to keep utPLSQL covered with unit tests.
144
144
> Lack of sufficient unit testing is a perfect reason for PR to be rejected.
145
145
146
146
To run a full suite of unit tests execute:
147
147
```bash
148
-
development/env.sh
149
-
test/install_and_run_tests.sh
148
+
. ./development/env.sh
149
+
./test/install_and_run_tests.sh
150
150
```
151
151
152
152
You can review the results of tests as well as see information about code coverage in `./coverage.html` file.
|**DOCKER_USER**<br />**DOCKER_PASSWORD**|_Your Docker Hub website credentials. They will be used to pull the private database images._|
195
195
196
196
### SQLCL
197
197
198
198
Our build configuration uses SQLCL to run the scripts, and you need to configure a few additional secure environment variables. After the first build, the downloaded file will be cached.
199
199
200
-
Variable | Description
201
-
---------|------------
202
-
**ORACLE_OTN_USER<br />ORACLE_OTN_PASSWORD** | _Your Oracle website credentials. They will be used to download SQLCL._
0 commit comments