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
+28-29Lines changed: 28 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
# How to contribute
2
2
3
3
The following are the guidelines everyone should use to contribute to utPLSQL.
4
-
Changes are welcome from all members of the Community.
4
+
Changes are welcome from all members of the Community.
5
5
6
6
# Getting Started
7
7
8
8
1. Create a [GitHub Account](https://github.com/join).
9
9
2. Fork the utPLSQL Repository and setup your local Repository. _See [how to Fork](https://help.github.com/articles/fork-a-repo) article_
10
-
* Each of the steps below are detailed in **Get started with development** section.
10
+
* Each of the steps below are detailed in **Get started with development** section.
11
11
* Clone your Fork to your local machine.
12
12
* Configure "upstream" remote to the [utPLSQL repository](https://github.com/utPLSQL/utPLSQL.git).
13
13
3. For each change you want to make:
14
14
* Make sure your forked repository is up to date with upstream before you start coding. See [syncing your local repository](https://help.github.com/articles/syncing-a-fork) with upstream utPLSQL repository.
15
15
* Create a new branch for your change. We use `feature/feature_name` or `bugfix/fixed_issue_name` to identify branch types.
16
-
* Make your change in your new branch.
16
+
* Make your change in your new branch.
17
17
* Make sure your change is covered with unit tests.
18
18
***Verify code compiles and all existing and new unit tests pass.**
19
19
* The quickest way to have a Pull Request not approved, is to submit code that does not compile or pass tests.
@@ -27,24 +27,24 @@ Changes are welcome from all members of the Community.
27
27
* We use snake case for all identifiers in PLSQL code. This separates keywords in names with underscores. `execute_test`
28
28
* All code is lower case.
29
29
* Prefixes:
30
-
* Arguments to procedures and functions will start with `a_` an Example would be procedure `is_valid(a_owner_name varchar2)`
30
+
* Arguments to procedures and functions will start with `a_`, an Example would be procedure `is_valid(a_owner_name varchar2)`
31
31
* Object types and packages will start with `ut_`
32
32
* Local variables `l_`
33
33
* Global variables `g_`
34
34
* Global Constants start with `gc_`
35
35
* Types in packages, objects start with `t_`
36
36
* Nested Tables start with `tt_`
37
-
* varchar2 lengths are set in characters not bytes
37
+
* varchar2 lengths are set in characters not bytes
38
38
39
39
40
40
# Configuring local environment
41
41
42
-
Your local environment can be of any flavor (Unix/Linux/Windows/Mac).
42
+
Your local environment can be of any flavor (Unix/Linux/Windows/Mac).
43
43
At minimum you need to have Oracle database 11.2 XE accessible for the project and SYS account access to install and develop utPLSQL.
44
44
45
45
We use four different database accounts (users) for development process.
46
46
*`ut3_latest_release` - holds latest released version of utPLSQL. This schema holds the testing framework used for self-testing of utPLSQL development.
47
-
*`ut3` - holds latest (current) development version of utPLSQL. This is the schema you will be working on.
47
+
*`ut3` - holds the version of utPLSQL of your current branch. This is the schema you will be working on.
48
48
*`ut3_tester` - holds unit test packages for development of utPLSQL.
49
49
*`ut3$user#` - used for testing accessibility to schema names with special characters.
50
50
@@ -56,7 +56,7 @@ To get started with development, follow the below steps.
56
56
57
57
_If you're using Windows, run the shell scripts using `GIT bash` - Windows-based bash command line._
58
58
59
-
### Clone your fork of utPLSQL git repository
59
+
### Clone your fork of utPLSQL git repository
60
60
61
61
```bash
62
62
# clone your fork of utPLSQL
@@ -73,7 +73,7 @@ git fetch --all
73
73
74
74
### Prepare environment script
75
75
76
-
Copy the environment variables template `development/template.env.sh` to `development/env.sh`
76
+
Copy the environment variables template `development/template.env.sh` to `development/env.sh`
77
77
```bash
78
78
cp development/template.env.sh development/env.sh
79
79
chmod u+w development/env.sh
@@ -109,10 +109,26 @@ You now have the following:
109
109
- sources from `master` branch of utPLSQL/utPLSQL repository in `utPLSQL/ut3_latest_release` directory
110
110
- binaries of `utplsql-cli` in `utPLSQL/utPLSQL-cli` directory
111
111
- database users created
112
-
-utPLSQL develop version deployed to`ut3` schema
112
+
-your current branch of utPLSQL deployed into`ut3` schema
113
113
- utPLSQL released version deployed to `ut3_latest_release`
114
114
115
-
At any time, if you need to refresh your database, the below scripts might be helpful.
115
+
At any time, if you need to refresh your database, the below scripts might be helpful.
116
+
117
+
## Cleanup of utPLSQL installation in local database
118
+
119
+
```bash
120
+
development/cleanup.sh
121
+
```
122
+
123
+
## Reinstalling utPLSQL development in `ut3` schema
124
+
125
+
```bash
126
+
development/refresh_ut3.sh
127
+
```
128
+
129
+
## Refreshing after release
130
+
131
+
Whenever a new version of utPLSQL or a new version of utPLSQL-cli is available, use `development/refresh_sources.sh` to refresh files in your local project folders.
You can review the results of tests as well as see information about code coverage in `./old_tests/coverage.html, ./coverage.html` files.
143
159
144
160
145
-
## Cleanup of utPLSQL installation in local database
146
-
147
-
```bash
148
-
development/cleanup.sh
149
-
```
150
-
151
-
## Reinstalling utPLSQL development in `ut3` schema
152
-
153
-
```bash
154
-
development/refresh_ut3.sh
155
-
```
156
-
157
-
## Refreshing after release
158
-
159
-
Whenever a new version of utPLSQL or a new version of utPLSQL-cli is available, use `development/refresh_sources.sh` to refresh files in your local project folders.
160
-
161
-
162
161
## Modules
163
162
164
163
Below diagram gives a high-level overview of utPLSQL v3 modules and their dependencies.
@@ -214,4 +213,4 @@ If you are new to GIT here are some links to help you with understanding how it
To run the script on windows you will need [PowerShell 3.0](https://blogs.technet.microsoft.com/heyscriptingguy/2013/06/02/weekend-scripter-install-powershell-3-0-on-windows-7/) or above.
0 commit comments