Skip to content

Commit bc26fea

Browse files
committed
Merge pull request utPLSQL#6 from rlove/feature/contrib
Created a CONTRIBUTING.md File
2 parents 638ad94 + 1b292d9 commit bc26fea

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## How to contribute ##
2+
3+
The following are the guidelines, everyone should use to contribute to utPLSQL.
4+
Changes are welcome from all members of the Community.
5+
6+
## Getting Started ##
7+
8+
1. Create a [GitHub Account](https://github.com/join).
9+
2. Fork the utPLSQL Repository and setup your local Repository.
10+
* Each of the steps below are detailed in the [How to Fork](https://help.github.com/articles/fork-a-repo) article!
11+
* Clone your Fork to your local machine.
12+
* Configure "upstream" remote to the [master utPLSQL repository](https://github.com/utPLSQL/utPLSQL.git).
13+
3. For each change you want to make:
14+
* Create a new branch for your change.
15+
* Make your change in your new branch.
16+
* Although changes can be made in the master branch, it easier long term if a new branch is used.
17+
* **Verify code compiles and unit tests still pass.**
18+
* The quickest way to have a Pull Request not be accepted, is to submit code that does not compile or pass tests.
19+
* Commit change to your local repository.
20+
* Push change to your remote repository
21+
* Submit a [Pull Request](https://help.github.com/articles/using-pull-requests).
22+
* Note: local and remote branches can be deleted after pull request has been accepted.
23+
24+
**Note:** Getting changes from others requires [Syncing your Local repository](https://help.github.com/articles/syncing-a-fork) with Master utPLSQL repository. This can happen at any time.
25+
26+
## New to GIT ##
27+
28+
If you are new to GIT here are some links to help you with understanding how it works.
29+
30+
- [GIT Documentation](http://git-scm.com/doc)
31+
- [Atlassian Git Tutorial](https://www.atlassian.com/git/tutorial/git-basics)
32+
- [What are other resources for learning Git and GitHub](https://help.github.com/articles/what-are-other-good-resources-for-learning-git-and-github)
33+

0 commit comments

Comments
 (0)