Skip to content

Commit 9a526d5

Browse files
authored
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 -->
1 parent 5192ba6 commit 9a526d5

File tree

5 files changed

+193
-70
lines changed

5 files changed

+193
-70
lines changed

.github/pull_request_template.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
## Summary
22

33
## How was it tested?
4+
5+
## Community Contribution License
6+
7+
All community contributions in this pull request are licensed to the project
8+
maintainers under the terms of the
9+
[Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0).
10+
11+
By creating this pull request, I represent that I have the right to license the
12+
contributions to the project maintainers under the Apache 2 License as stated in
13+
the
14+
[Community Contribution License](https://github.com/jetify-com/opensource/blob/main/CONTRIBUTING.md#community-contribution-license).

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ representative at an online or offline event.
5959
## Enforcement
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement. Use the
63-
"Report to repository admins" functionality on GitHub to report.
62+
reported to the community leaders responsible for enforcement. Use the "Report
63+
to repository admins" functionality on GitHub to report.
6464

6565
All complaints will be reviewed and investigated promptly and fairly.
6666

CONTRIBUTING.md

Lines changed: 60 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Contributing
22

3-
When contributing to this repository, please describe the change you wish to make via a related issue, or a pull request.
3+
When contributing to this repository, please describe the change you wish to
4+
make via a related issue, or a pull request.
45

5-
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
6+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
7+
all your interactions with the project.
68

79
## Setting Up Development Environment
810

9-
Before making any changes to the source code (documentation excluded) make sure you have installed all the required tools.
11+
Before making any changes to the source code (documentation excluded) make sure
12+
you have installed all the required tools.
1013

1114
### With Devbox
1215

@@ -21,26 +24,35 @@ The easiest way to develop Devbox is with Devbox!
2124
git clone https://github.com/jetify-com/devbox.git go.jetify.com/devbox
2225
cd go.jetify.com/devbox
2326

24-
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:
2529

2630
devbox run build
2731

2832
4. Start a development shell using your build of Devbox:
2933

3034
dist/devbox shell
3135

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".
3443

3544
### Setting up the Environment Without Devbox
3645

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.
3848

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):
4051

4152
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
4253

43-
Alternatively, you can also use [the official installer](https://nixos.org/download.html).
54+
Alternatively, you can also use
55+
[the official installer](https://nixos.org/download.html).
4456

4557
2. Install [Go](https://go.dev/doc/install) (current version: 1.20)
4658

@@ -53,29 +65,52 @@ If you are unable to install or use Devbox, you can manually replicate the envir
5365

5466
## Pull Request Process
5567

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.
5873
3. Run `devbox run lint` and `devbox run test`.
5974
4. Run `go mod tidy` if you added any new dependencies.
6075
5. Submit your pull request and someone will take a look!
6176

6277
### Style Guide
6378

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
95+
[Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0).
96+
97+
```
98+
By making a contribution to this project, you certify that:
6599
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
68102
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
70107
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.
72110
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)
115+
involved.
116+
```

0 commit comments

Comments
 (0)