Skip to content

Commit 94f8a23

Browse files
halmaihalmai
authored
Merge branch 'master' into feature_update_version
2 parents 5532e5b + f966e9f commit 94f8a23

2 files changed

Lines changed: 349 additions & 98 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 67 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,35 @@ Contributing to Okta Open Source Repos
44
Sign the CLA
55
------------
66

7-
If you haven't already, [sign the CLA](https://developer.okta.com/cla/). Common questions/answers are also listed on the CLA page.
7+
If you haven't already, [sign the CLA](https://developer.okta.com/cla/).
8+
Common questions/answers are also listed on the CLA page.
89

910
Summary
1011
-------
11-
This document covers how to contribute to an Okta Open Source project. These instructions assume you have a GitHub
12-
.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to
13-
your own fork of the Okta Golang SDK project and you will submit a Pull Request for your changes to be added.
12+
13+
This document covers how to contribute to an Okta Open Source project. These
14+
instructions assume you have a GitHub .com account, so if you don't have one
15+
you will have to create one. Your proposed code changes will be published to
16+
your own fork of the Okta Golang SDK project and you will submit a Pull Request
17+
for your changes to be added.
1418

1519
_Lets get started!!!_
1620

1721

1822
Fork the code
1923
-------------
2024

21-
In your browser, navigate to: [https://github.com/okta/okta-sdk-golang](https://github.com/okta/okta-sdk-golang)
25+
In your browser, navigate to:
26+
[https://github.com/okta/okta-sdk-golang](https://github.com/okta/okta-sdk-golang)
2227

23-
Fork the repository by clicking on the 'Fork' button on the top right hand side. The fork will happen and you will be taken to your own fork of the repository. Copy the Git repository URL by clicking on the clipboard next to the URL on the right hand side of the page under '**HTTPS** clone URL'. You will paste this URL when doing the following `git clone` command.
28+
Fork the repository by clicking on the 'Fork' button on the top right hand
29+
side. The fork will happen and you will be taken to your own fork of the
30+
repository. Copy the Git repository URL by clicking on the clipboard next to
31+
the URL on the right hand side of the page under '**HTTPS** clone URL'. You
32+
will paste this URL when doing the following `git clone` command.
2433

25-
On your computer, follow these steps to setup a local repository for working on the Okta Golang SDK:
34+
On your computer, follow these steps to setup a local repository for working on
35+
the Okta Golang SDK:
2636

2737
``` bash
2838
$ git clone https://github.com/YOUR_ACCOUNT/okta-sdk-golang.git
@@ -33,15 +43,19 @@ $ git fetch upstream
3343
$ git rebase upstream/master
3444
```
3545

36-
3746
Making changes
3847
--------------
3948

40-
It is important that you create a new branch to make changes on and that you do not change the `master`
41-
branch (other than to rebase in changes from `upstream/master`). In this example I will assume you will be making
42-
your changes to a branch called `feature_x`. This `feature_x` branch will be created on your local repository and will be pushed to your forked repository on GitHub. Once this branch is on your fork you will create a Pull Request for the changes to be added to the Okta Golang SDK project.
49+
It is important that you create a new branch to make changes on and that you do
50+
not change the `master` branch (other than to rebase in changes from
51+
`upstream/master`). In this example I will assume you will be making your
52+
changes to a branch called `feature_x`. This `feature_x` branch will be
53+
created on your local repository and will be pushed to your forked repository
54+
on GitHub. Once this branch is on your fork you will create a Pull Request for
55+
the changes to be added to the Okta Golang SDK project.
4356

44-
It is best practice to create a new branch each time you want to contribute to the project and only track the changes for that pull request in this branch.
57+
It is best practice to create a new branch each time you want to contribute to
58+
the project and only track the changes for that pull request in this branch.
4559

4660
``` bash
4761
$ git checkout master
@@ -52,22 +66,30 @@ $ git add <files>
5266
$ git commit -m "descriptive commit message for your changes"
5367
```
5468

55-
> The `-b` specifies that you want to create a new branch called `feature_x`. You only specify `-b` the first time you checkout because you are creating a new branch. Once the `feature_x` branch exists, you can later switch to it with only `git checkout feature_x`.
69+
> The `-b` specifies that you want to create a new branch called `feature_x`.
70+
> You only specify `-b` the first time you checkout because you are creating a
71+
> new branch. Once the `feature_x` branch exists, you can later switch to it
72+
> with only `git checkout feature_x`.
5673
5774

5875
Rebase `feature_x` to include updates from `upstream/master`
5976
------------------------------------------------------------
6077

61-
It is important that you maintain an up-to-date `master` branch in your local repository. This is done by rebasing in
62-
the code changes from `upstream/master` (the official Okta Java SDK project repository) into your local repository.
63-
You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. I recommend you do this process periodically while you work to make sure you are working off the most recent project code.
78+
It is important that you maintain an up-to-date `master` branch in your local
79+
repository. This is done by rebasing in the code changes from
80+
`upstream/master` (the official Okta Golang SDK project repository) into your
81+
local repository. You will want to do this before you start working on a
82+
feature as well as right before you submit your changes as a pull request. I
83+
recommend you do this process periodically while you work to make sure you are
84+
working off the most recent project code.
6485

6586
This process will do the following:
6687

6788
1. Checkout your local `master` branch
68-
2. Synchronize your local `master` branch with the `upstream/master` so you have all the latest changes from the
69-
project
70-
3. Rebase the latest project code into your `feature_x` branch so it is up-to-date with the upstream code
89+
2. Synchronize your local `master` branch with the `upstream/master` so you
90+
have all the latest changes from the project
91+
3. Rebase the latest project code into your `feature_x` branch so it is
92+
up-to-date with the upstream code
7193

7294
``` bash
7395
$ git checkout master
@@ -83,36 +105,49 @@ $ git rebase master
83105
Make a GitHub Pull Request to contribute your changes
84106
-----------------------------------------------------
85107

86-
When you are happy with your changes and you are ready to contribute them, you will create a Pull Request on GitHub to do so. This is done by pushing your local changes to your forked repository (default remote name is `origin`) and then initiating a pull request on GitHub.
108+
When you are happy with your changes and you are ready to contribute them, you
109+
will create a Pull Request on GitHub to do so. This is done by pushing your
110+
local changes to your forked repository (default remote name is `origin`) and
111+
then initiating a pull request on GitHub.
87112

88-
> **IMPORTANT:** Make sure you have rebased your `feature_x` branch to include the latest code from `upstream/master`
113+
> **IMPORTANT:** Make sure you have rebased your `feature_x` branch to include
114+
> the latest code from `upstream/master`
89115
_before_ you do this.
90116

91117
``` bash
92118
$ git push origin master
93119
$ git push origin feature_x
94120
```
95121

96-
Now that the `feature_x` branch has been pushed to your GitHub repository, you can initiate the pull request.
122+
Now that the `feature_x` branch has been pushed to your GitHub repository, you
123+
can initiate the pull request.
97124

98125
To initiate the pull request, do the following:
99126

100-
1. In your browser, navigate to your forked repository: [https://github.com/YOUR_ACCOUNT/okta-sdk-golang](https://github
101-
.com/YOUR_ACCOUNT/okta-sdk-golang)
102-
2. Click the new button called '**Compare & pull request**' that showed up just above the main area in your forked repository
103-
3. Validate the pull request will be into the upstream `master` and will be from your `feature_x` branch
104-
4. Enter a detailed description of the work you have done and then click '**Send pull request**'
105-
106-
If you are requested to make modifications to your proposed changes, make the changes locally on your `feature_x` branch, re-push the `feature_x` branch to your fork. The existing pull request should automatically pick up the change and update accordingly.
127+
1. In your browser, navigate to your forked repository:
128+
[https://github.com/YOUR_ACCOUNT/okta-sdk-golang](https://github.com/YOUR_ACCOUNT/okta-sdk-golang)
129+
2. Click the new button called '**Compare & pull request**' that showed up just
130+
above the main area in your forked repository
131+
3. Validate the pull request will be into the upstream `master` and will be
132+
from your `feature_x` branch
133+
4. Enter a detailed description of the work you have done and then click
134+
'**Send pull request**'
107135

136+
If you are requested to make modifications to your proposed changes, make the
137+
changes locally on your `feature_x` branch, re-push the `feature_x` branch to
138+
your fork. The existing pull request should automatically pick up the change
139+
and update accordingly.
108140

109141
Cleaning up after a successful pull request
110142
-------------------------------------------
111143

112-
Once the `feature_x` branch has been committed into the `upstream/master` branch, your local `feature_x` branch and
113-
the `origin/feature_x` branch are no longer needed. If you want to make additional changes, restart the process with a new branch.
144+
Once the `feature_x` branch has been committed into the `upstream/master`
145+
branch, your local `feature_x` branch and the `origin/feature_x` branch are no
146+
longer needed. If you want to make additional changes, restart the process
147+
with a new branch.
114148

115-
> **IMPORTANT:** Make sure that your changes are in `upstream/master` before you delete your `feature_x` and
149+
> **IMPORTANT:** Make sure that your changes are in `upstream/master` before
150+
> you delete your `feature_x` and
116151
`origin/feature_x` branches!
117152

118153
You can delete these deprecated branches with the following:

0 commit comments

Comments
 (0)