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
{{ message }}
This repository was archived by the owner on Jun 13, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-20Lines changed: 28 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,26 @@ When contributing to this repository, please describe the change you wish to mak
5
5
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
6
6
7
7
## Setting Up Development Environment
8
+
8
9
Before making any changes to the source code (documentation excluded) make sure you have installed all the required tools. We use Devbox to manage our development environment.
* Use devbox to init your development environment:
16
-
*```bash
17
-
cd go.jetpack.io/launchpad
18
+
- Use devbox to init your development environment:
19
+
- ```bash
20
+
cd go.jetify.com/launchpad
18
21
```
19
-
*```bash
20
-
devbox shell
22
+
- ```bash
23
+
devbox shell
21
24
```
22
25
23
26
## Building and Testing
27
+
24
28
Launchpad is setup like a typical Go project. After installing the required tools and setting up your environment. You can make changes in the source code, build, and test your changes by following these steps:
25
29
26
30
1. Install dependencies:
@@ -37,54 +41,58 @@ Launchpad is setup like a typical Go project. After installing the required tool
37
41
./dist/launchpad <your_test_command>
38
42
```
39
43
40
-
41
44
## Pull Request Process
42
45
43
46
1. Ensure any new feature or functionality also includes tests to verify its correctness.
44
47
45
48
2. Ensure any new dependency is also included in [go.mod](go.mod) file
46
49
47
-
2. Ensure any binary file as a result of build (e.g., `./launchpad`) are removed and/or excluded from tracking in git.
50
+
3. Ensure any binary file as a result of build (e.g., `./launchpad`) are removed and/or excluded from tracking in git.
48
51
49
-
3. Update the [README.md](README.md) and/or docs with details of changes to the interface, this includes new environment
52
+
4. Update the [README.md](README.md) and/or docs with details of changes to the interface, this includes new environment
50
53
variables, new commands, new flags, and useful file locations.
51
54
52
-
4. You may merge the Pull Request in once you have the sign-off of developers/maintainers, or if you
55
+
5. You may merge the Pull Request in once you have the sign-off of developers/maintainers, or if you
53
56
do not have permission to do that, you may request the maintainers to merge it for you.
54
57
55
58
## Developer Certificate of Origin
59
+
56
60
By contributing to this project you agree to the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) which was created by the Linux Foundation and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO description for details below:
61
+
57
62
> Developer Certificate of Origin
58
-
>
63
+
>
59
64
> Version 1.1
60
65
>
61
66
> Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
62
67
>
63
68
> Everyone is permitted to copy and distribute verbatim copies of this
64
-
license document, but changing it is not allowed.
65
-
>
69
+
> license document, but changing it is not allowed.
66
70
>
67
71
> Developer's Certificate of Origin 1.1
68
72
>
69
73
> By making a contribution to this project, I certify that:
70
-
>
74
+
>
71
75
> (a) The contribution was created in whole or in part by me and I
76
+
72
77
have the right to submit it under the open source license
73
78
indicated in the file; or
74
-
>
79
+
75
80
> (b) The contribution is based upon previous work that, to the best
81
+
76
82
of my knowledge, is covered under an appropriate open source
77
83
license and I have the right under that license to submit that
78
84
work with modifications, whether created in whole or in part
79
85
by me, under the same open source license (unless I am
80
86
permitted to submit under a different license), as indicated
81
87
in the file; or
82
-
>
88
+
83
89
> (c) The contribution was provided directly to me by some other
90
+
84
91
person who certified (a), (b) or (c) and I have not modified
85
92
it.
86
-
>
93
+
87
94
> (d) I understand and agree that this project and the contribution
95
+
88
96
are public and that a record of the contribution (including all
89
97
personal information I submit with it, including my sign-off) is
90
98
maintained indefinitely and may be redistributed consistent with
Read more on the [Launchpad docs](http://www.jetpack.io/launchpad/docs/getting-started/any-image-to-k8s-5-min/).
32
-
33
31
## Benefits
34
32
35
33
### A Zero Ops workflow
@@ -40,10 +38,6 @@ Launchpad builds any image, publishes it to your Docker Registry, and deploys it
40
38
41
39
Ever wonder how you'd graduate from Heroku or a single EC2 machine to Kubernetes without going through a painful setup again? Faint not! With Launchpad, no manual migrations are required. In fact, developers can deploy and run their applications without needing to learn Kubernetes.
42
40
43
-
### With Mission Control, onboarding new members is as easy as "launchpad up"
44
-
45
-
Adding a new member to the team? Forget about Registry access, Cluster credentials, Kubernetes configurations, Namespace permissions, and a million other things to take care of. With Jetpack's Mission Control, Launchpad can automatically create all of the above for each new developer.
46
-
47
41
### Secret management built-in
48
42
49
43
Secrets are tied to your launchpad projects, so they can be shared and updated securely by your team.
@@ -100,8 +94,6 @@ In this quickstart, we’ll deploy a cron job to your local Docker Desktop Kuber
100
94
> kubectl logs <pod_name>
101
95
```
102
96
103
-
[kubectl](https://www.jetpack.io/launchpad/docs/getting-started/any-image-to-k8s-5-min/#prerequisites), while not required, is a useful tool for inspecting and managing your deployments in Kubernetes.
104
-
105
97
7. Clean up:
106
98
107
99
```bash
@@ -118,15 +110,12 @@ In this quickstart, we’ll deploy a cron job to your local Docker Desktop Kuber
118
110
119
111
`launchpad cluster` - create a cluster, list your clusters (login required)
120
112
121
-
All "login required" commands require you to have an account with [Jetpack's Mission Control](https://www.jetpack.io/launchpad) offering. These special commands are added on top of the open-source codebase for you. Even though they are excluded from this repository, they are readily available in the launchpad CLI.
122
-
123
-
See the [CLI Reference](https://www.jetpack.io/launchpad/docs/reference/cli/) for the full list of commands.
124
113
125
114
## Join our Developer Community
126
115
127
-
- Chat with us by joining the [Jetpack.io Discord Server](https://discord.gg/jetpack-io) – we have a #launchpad channel dedicated to this project.
128
-
- File bug reports and feature requests using [Github Issues](https://github.com/jetpack-io/launchpad/issues)
129
-
- Follow us on [Jetpack's Twitter](https://twitter.com/jetpack_io) for product updates
116
+
- Chat with us by joining the [Jetify's Discord Server](https://discord.gg/jetify) – we have a #launchpad channel dedicated to this project.
117
+
- File bug reports and feature requests using [Github Issues](https://github.com/jetify-com/launchpad/issues)
118
+
- Follow us on [Jetpack's Twitter](https://twitter.com/jetify_com) for product updates
0 commit comments