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
Clarify license and terms for contributions, reformat markdown (#2546)
## Summary
Tweaks several of our files to more clearly explain under what terms we
accept contributions.
Reformat markdown files to fit under an 80 character width.
## How was it tested?
N/A
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Introduced a new section detailing the licensing terms for community
contributions under the Apache 2 License.
- Updated contribution guidelines by replacing outdated certification
details with the new licensing information.
- Improved overall readability and formatting across community
guidelines, the code of conduct, and other support documents for a
clearer, more streamlined experience.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
3. Build the Devbox CLI. If you don't have Nix installed, Devbox will automatically install it for you before building:
27
+
3. Build the Devbox CLI. If you don't have Nix installed, Devbox will
28
+
automatically install it for you before building:
25
29
26
30
devbox run build
27
31
28
32
4. Start a development shell using your build of Devbox:
29
33
30
34
dist/devbox shell
31
35
32
-
Tip: you can also start VSCode from inside your Devbox shell with `devbox run code`.
33
-
- If you are encountering an error similar to: `line 3: command 'code' not found`, this means you do not have the Visual Studio Code "Shell Command" installed. To do this, follow the official guide: https://code.visualstudio.com/docs/setup/mac. Please refer to the section under: "Launching from the command line".
36
+
Tip: you can also start VSCode from inside your Devbox shell with
37
+
`devbox run code`.
38
+
39
+
- If you encounter an error similar to: `line 3: command 'code' not found`, it
40
+
means you do not have the Visual Studio Code "Shell Command" installed. Follow
41
+
the official guide at https://code.visualstudio.com/docs/setup/mac. Please
42
+
refer to the section under: "Launching from the command line".
34
43
35
44
### Setting up the Environment Without Devbox
36
45
37
-
If you are unable to install or use Devbox, you can manually replicate the environment by following the steps below.
46
+
If you are unable to install or use Devbox, you can manually replicate the
47
+
environment by following the steps below.
38
48
39
-
1. Install Nix Package Manager. We recommend using the [Determinate Systems installer](https://github.com/DeterminateSystems/nix-installer):
49
+
1. Install Nix Package Manager. We recommend using the
50
+
[Determinate Systems installer](https://github.com/DeterminateSystems/nix-installer):
@@ -53,29 +65,52 @@ If you are unable to install or use Devbox, you can manually replicate the envir
53
65
54
66
## Pull Request Process
55
67
56
-
1. For new features or non-trivial changes, consider first filing an issue to discuss what changes you plan on making. This will let us help you with implementation details and to make sure we don't duplicate any work.
57
-
2. Ensure any new feature or functionality includes tests to verify its correctness.
68
+
1. For new features or non-trivial changes, consider first filing an issue to
69
+
discuss what changes you intend to make. This will let us help you with
70
+
implementation details and to make sure we don't duplicate any work.
71
+
2. Ensure any new feature or functionality includes tests to verify its
72
+
correctness.
58
73
3. Run `devbox run lint` and `devbox run test`.
59
74
4. Run `go mod tidy` if you added any new dependencies.
60
75
5. Submit your pull request and someone will take a look!
61
76
62
77
### Style Guide
63
78
64
-
We don't expect you to read through a long style guide or be an expert in Go before contributing. When necessary, a reviewer will be happy to help out with any suggestions around code style when you submit your PR. Otherwise, the Devbox codebase generally follows common Go idioms and patterns:
79
+
We don't expect you to read through a long style guide or be an expert in Go
80
+
before contributing. When necessary, a reviewer will be happy to help out with
81
+
any suggestions around code style when you submit your PR. Otherwise, the Devbox
82
+
codebase generally follows common Go idioms and patterns:
83
+
84
+
- If you're unfamiliar with idiomatic Go,
85
+
[Effective Go](https://go.dev/doc/effective_go) and the
86
+
[Google Go Style Guide](https://google.github.io/styleguide/go) are good
87
+
resources.
88
+
- There's no strict commit message format, but a good practice is to start the
89
+
subject with the name of the Go packages you add/modified. For example,
90
+
`boxcli: update help for add command`.
91
+
92
+
## Community Contribution License
93
+
94
+
Contributions made to this project must be made under the terms of the
By making a contribution to this project, you certify that:
65
99
66
-
- If you're unfamiliar with idiomatic Go, [Effective Go](https://go.dev/doc/effective_go) and the [Google Go Style Guide](https://google.github.io/styleguide/go) are good resources.
67
-
- There's no strict commit message format, but a good practice is to start the subject with the name of the Go packages you add/modified. For example, `boxcli: update help for add command`.
100
+
a. The contribution was created in whole or in part by you and you have the right
101
+
to submit it under the Apache 2 License; or
68
102
69
-
## Developer Certificate of Origin
103
+
b. The contribution is based upon previous work that, to the best of your
104
+
knowledge, is covered under an appropriate open source license and you have the
105
+
right under that license to submit that work with modifications, whether
106
+
created in whole or in part by you, under the Apache 2 License; or
70
107
71
-
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:
108
+
c. The contribution was provided directly to you by some other person who
109
+
certified (a), (b) or (c) and you have not modified it.
72
110
73
-
> By making a contribution to this project, I certify that:
74
-
>
75
-
> a. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
76
-
>
77
-
> b. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
78
-
>
79
-
> c. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
80
-
>
81
-
> d. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
111
+
d. You understand and agree that this project and the contribution are public
112
+
and that a record of the contribution (including all personal information you
113
+
submit with it, including your sign-off) is maintained indefinitely and may be
114
+
redistributed consistent with this project or the open source license(s)
0 commit comments