Contributing

How to contribute¶

The following are the guidelines, everyone should use to contribute to utPLSQL.
Changes are welcome from all members of the Community.

Create a GitHub Account.
Fork the utPLSQL Repository and setup your local Repository.
- Each of the steps below are detailed in the How to Fork article!
- Clone your Fork to your local machine.
- Configure "upstream" remote to the master utPLSQL repository.
- Update the git submodules by issuing command: git submodule update --remote --merge
For each change you want to make:
- Create a new branch for your change.
- Make your change in your new branch.
  - Although changes can be made in the master branch, it easier long term if a new branch is used.
- Make sure your change is covered with unit tests and/or is represented in examples
- Verify code compiles and all existing and new unit tests pass.
  - The quickest way to have a Pull Request not be accepted, is to submit code that does not compile or pass tests.
- Commit change to your local repository.
- Push change to your remote repository
- Submit a Pull Request.
- Note: local and remote branches can be deleted after pull request has been accepted.

Note: Getting changes from others requires Syncing your Local repository with Master utPLSQL repository. This can happen at any time.

Snake case will be used. This separates keywords in names with underscores. execute_test
All names will be lower case.
Prefixes:
- Arguments to procedures and functions will start with a_ an Example would be procedure is_valid(a_owner_name varchar2);
- Object types and packages will start with ut_
- Local variables l_
- Global variables g_
- Global Constants start with gc_
- Types in packages, objects start with t_
- Nested Tables start with tt_
varchar2 lengths are set in characters not bytes

If you are new to GIT here are some links to help you with understanding how it works.

Last update: March 20, 2017 22:26:32
Created: August 1, 2016 21:15:22