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
[MacOS Dev Guide]: https://kubectl.docs.kubernetes.io/contributing/kustomize/mac/
18
19
[Windows Dev Guide]: https://kubectl.docs.kubernetes.io/contributing/kustomize/windows/
@@ -25,13 +26,88 @@ _As contributors and maintainers of this project, and in the interest of fosteri
25
26
26
27
## Getting Started
27
28
28
-
Dev guides:
29
-
30
-
-[Contribution Guide]
31
-
-[MacOS Dev Guide]
32
-
-[Windows Dev Guide]
33
-
34
-
General resources for contributors:
29
+
### Forking Kustomize and Working Locally
30
+
The Kustomize project uses a "Fork and Pull" workflow that is standard to GitHub. In git terms, your personal fork is referred to as the "origin" and the actual project's git repository is called "upstream". To keep your personal branch (origin) up to date with the project (upstream), it must be configured within your local working copy.
You will need to periodically fetch changes from the `upstream` repository to keep your working branch in sync.
64
+
```bash
65
+
cd kustomize
66
+
git fetch upstream
67
+
git checkout myfeature
68
+
git rebase upstream/master
69
+
```
70
+
71
+
### Push to GitHub
72
+
When your changes are ready for review, push your working branch to your fork on GitHub.
73
+
```bash
74
+
cd kustomize
75
+
git push origin myfeature
76
+
```
77
+
78
+
### Create a Pull Request
79
+
1. Visit your fork at `https://github.com/<user>/kustomize`
80
+
2. Click the **Compare & Pull Request** button next to your `myfeature` branch.
81
+
3. Check out the pull request [process](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md) for more details and advice.
82
+
83
+
If you ran `git push` in the previous step, GitHub will return a useful link to create a Pull Request.
84
+
85
+
86
+
### Build Kustomize
87
+
The [Kustomize Architecture] document describes the respository organization and the kustomize build process.
88
+
```bash
89
+
# For go version >= 1.13
90
+
unset GOPATH
91
+
unset GO111MODULES
92
+
93
+
# Build kustomize binary and install in go bin path
94
+
cd kustomize
95
+
make kustomize
96
+
97
+
# Run unit tests
98
+
make test-unit-all
99
+
100
+
# Run linter
101
+
make lint
102
+
103
+
# Test examples against HEAD
104
+
make test-examples-kustomize-against-HEAD
105
+
106
+
# Run your development version
107
+
~/go/bin/kustomize version
108
+
```
109
+
110
+
### General resources for contributors
35
111
36
112
-[Contributor License Agreement] - Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests.
37
113
-[Kubernetes Contributor Guide] - Main contributor documentation.
0 commit comments