Skip to content

Commit 8f4966c

Browse files
NautiluXNautiluX
authored
docs: Update contribution docs (#16)
* docs: Update contribution docs * Add code of conduct * Add Contributing * Add some badges to README * Add links to docs to README * Update licenses * devx(build-deps): Automatically install missing build dependencies * Add DCO
1 parent 6d8caa5 commit 8f4966c

File tree

12 files changed

+334
-7
lines changed

12 files changed

+334
-7
lines changed

‎.github/dco.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
allowRemediationCommits:
2+
# Allow individual remediation commits
3+
# https://github.com/cncf/dco2?#individual
4+
individual: false
5+
# Allow third-party remediation commits
6+
# https://github.com/cncf/dco2?#third-party
7+
thirdParty: false
8+
9+
require:
10+
# https://github.com/cncf/dco2?#skipping-sign-off-for-organization-members
11+
members: false

‎CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
133+

‎CONTRIBUTING.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Contributing to Codesphere Go SDK & CLI
2+
3+
We welcome contributions of all kinds! By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
4+
5+
## How to Report Issues
6+
7+
If you encounter a bug or have a feature request, please [open a new issue](https://github.com/codesphere-cloud/cs-go/issues/new) on GitHub. Please include the following information:
8+
9+
* **Operating System and Version:**
10+
* **Codesphere Go SDK & CLI Version (if applicable):**
11+
* **Steps to Reproduce the Bug:**
12+
* **Expected Behavior:**
13+
* **Actual Behavior:**
14+
* **Any relevant logs or error messages:**
15+
16+
## How to Suggest Features or Improvements
17+
18+
We'd love to hear your ideas! Please [open a new issue](https://github.com/codesphere-cloud/cs-go/issues/new) to discuss your proposed feature or improvement before submitting code. This allows us to align on the design and approach.
19+
20+
## Contributing Code
21+
22+
If you'd like to contribute code, please follow these steps:
23+
24+
1. **Fork the Repository:** Fork this repository to your GitHub account.
25+
2. **Create a Branch:** Create a new branch for your changes: `git checkout -b feature/your-feature-name`
26+
3. **Set Up Development Environment:**
27+
28+
* Ensure you have Go installed. The minimum required Go version is specified in the `go.mod` file.
29+
* Clone your forked repository: `git clone git@github.com:your-username/cs-go.git`
30+
* Navigate to the project directory: `cd cs-go`
31+
* Run `make`: This command should download necessary dependencies and build the CLI.
32+
33+
4. **Follow Coding Standards:**
34+
35+
* Please ensure your code is properly formatted using `go fmt`.
36+
* We use [golangci-lint](https://golangci-lint.run/) for static code analysis. Please run it locally before submitting a pull request: `make lint`.
37+
38+
5. **Write Tests:**
39+
40+
* We use [Ginkgo](https://github.com/onsi/ginkgo) and [Gomega](https://github.com/onsi/gomega) for testing.
41+
* Please write tests for your code using Ginkgo and Gomega and add them to the `_test.go` files.
42+
* Aim for good test coverage.
43+
44+
6. **Build and Test:**
45+
46+
* Ensure everything is working correctly by running the appropriate `make` targets (e.g., `make build`, `make test`). The `make test` target should run the Ginkgo tests.
47+
48+
7. **Commit Your Changes:**
49+
50+
* We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. Please format your commit messages according to the Conventional Commits specification. Examples:
51+
* `fix(api): Handle edge case in API client`
52+
* `feat(cli): Add new command for listing resources`
53+
* `docs: Update contributing guide with commit message conventions`
54+
* **Developer Certificate of Origin (DCO)**
55+
56+
In order to contribute to this project, you must agree to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). This is a simple statement that you, as a contributor, have the right to submit the code you are contributing.
57+
58+
```text
59+
Developer's Certificate of Origin 1.1
60+
61+
By making a contribution to this project, I certify that:
62+
63+
(a) The contribution was created in whole or in part by me and I
64+
have the right to submit it under the open source license
65+
indicated in the file; or
66+
67+
(b) The contribution is based upon previous work that, to the best
68+
of my knowledge, is covered under an appropriate open source
69+
license and I have the right under that license to submit that
70+
work with modifications, whether created in whole or in part
71+
by me, or solely by me; or
72+
73+
(c) The contribution was provided directly to me by some other
74+
person who certified (a), (b) or (c) and I have not modified
75+
it.
76+
77+
(d) I understand and agree that this project and the contribution
78+
are public and that a record of the contribution (including all
79+
personal information I submit with it) is maintained indefinitely
80+
and may be redistributed consistent with this project or the
81+
open source license(s) involved.
82+
```
83+
84+
To indicate that you accept the DCO, you must add a `Signed-off-by` line to each of your commit messages. Here's an example:
85+
86+
```
87+
Fix: Handle edge case in API client
88+
89+
This commit fixes a bug where the API client would crash when receiving
90+
an empty response.
91+
92+
Signed-off-by: John Doe <john.doe@example.com>
93+
```
94+
95+
You can add this line to your commit message using the `-s` flag with the `git commit` command:
96+
97+
```bash
98+
git commit -s -m "Your commit message"
99+
```
100+
101+
8. **Submit a Pull Request:** [Open a new pull request](https://github.com/codesphere-cloud/cs-go/compare) to the `main` branch of this repository. Please include a clear description of your changes and reference any related issues.
102+
103+
## Code Review Process
104+
105+
All contributions will be reviewed by project maintainers. Please be patient during the review process and be prepared to make revisions based on feedback. We aim for thorough but timely reviews.
106+
107+
## License
108+
109+
By contributing to Codesphere Go SDK & CLI, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).
110+
111+
## Community
112+
113+
Connect with the community and ask questions by joining our mailing list: [cs-go@codesphere.com](mailto:cs-go@codesphere.com).
114+
115+
Thank you for your interest in contributing to Codesphere Go SDK & CLI!

‎Makefile‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ test:
1313
# -count=1 to disable caching test results
1414
go test ./... -count=1
1515

16-
generate:
16+
generate: install-build-deps
1717
go generate ./...
1818

1919
build:
@@ -24,9 +24,12 @@ install:
2424
cd cmd/cs && go install
2525

2626
generate-client:
27+
ifeq (, $(shell which openapi-generator-cli))
28+
$(error "openapi-generator-cli not found, please install, e.g. using brew. See https://openapi-generator.tech/docs/installation")
29+
endif
2730
rm -rf ${OPENAPI_DIR}
2831
openapi-generator-cli generate -g go -o ${OPENAPI_DIR} -i https://codesphere.com/api/docs \
29-
--additional-properties=generateInterfaces=true,isGoSubmodule=true,withGoMod=false,packageName=openapi_client \
32+
--additional-properties=generateInterfaces=true,isGoSubmodule=true,withGoMod=false,packageName=openapi_client,disallowAdditionalPropertiesIfNotSet=false \
3033
--type-mappings=integer=int \
3134
--template-dir openapi-template \
3235
--skip-validate-spec # TODO: remove once the Codesphere openapi spec is fixed
@@ -46,13 +49,20 @@ generate-client:
4649

4750
generate-api: generate-client format
4851

49-
generate-license: install-build-deps
52+
generate-license:
5053
go-licenses report --template .NOTICE.template ./... > NOTICE
5154
copywrite headers apply
5255

5356
install-build-deps:
57+
ifeq (, $(shell which mockery))
5458
go install github.com/vektra/mockery/v3@v3.2.1
59+
endif
60+
ifeq (, $(shell which go-licenses))
5561
go install github.com/google/go-licenses@v1.6.0
62+
endif
63+
ifeq (, $(shell which copywrite))
5664
go install github.com/hashicorp/copywrite@v0.22.0
65+
endif
66+
ifeq (, $(shell which golangci-lint))
5767
go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.2
58-
68+
endif

‎NOTICE‎

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ Copyright (c) Codesphere Inc.
33

44
This project includes code licensed under the following terms:
55

6+
----------
7+
Module: github.com/davecgh/go-spew/spew
8+
Version: v1.1.1
9+
License: ISC
10+
License URL: https://github.com/davecgh/go-spew/blob/v1.1.1/LICENSE
11+
612
----------
713
Module: github.com/jedib0t/go-pretty/v6
814
Version: v6.6.7
@@ -15,6 +21,12 @@ Version: v0.0.16
1521
License: MIT
1622
License URL: https://github.com/mattn/go-runewidth/blob/v0.0.16/LICENSE
1723

24+
----------
25+
Module: github.com/pmezard/go-difflib/difflib
26+
Version: v1.0.0
27+
License: BSD-3-Clause
28+
License URL: https://github.com/pmezard/go-difflib/blob/v1.0.0/LICENSE
29+
1830
----------
1931
Module: github.com/rivo/uniseg
2032
Version: v0.4.7
@@ -33,16 +45,34 @@ Version: v1.0.6
3345
License: BSD-3-Clause
3446
License URL: https://github.com/spf13/pflag/blob/v1.0.6/LICENSE
3547

48+
----------
49+
Module: github.com/stretchr/objx
50+
Version: v0.5.2
51+
License: MIT
52+
License URL: https://github.com/stretchr/objx/blob/v0.5.2/LICENSE
53+
54+
----------
55+
Module: github.com/stretchr/testify
56+
Version: v1.10.0
57+
License: MIT
58+
License URL: https://github.com/stretchr/testify/blob/v1.10.0/LICENSE
59+
3660
----------
3761
Module: golang.org/x/text
38-
Version: v0.22.0
62+
Version: v0.23.0
3963
License: BSD-3-Clause
40-
License URL: https://cs.opensource.google/go/x/text/+/v0.22.0:LICENSE
64+
License URL: https://cs.opensource.google/go/x/text/+/v0.23.0:LICENSE
4165

4266
----------
4367
Module: gopkg.in/validator.v2
4468
Version: v2.0.1
4569
License: Apache-2.0
4670
License URL: https://github.com/go-validator/validator/blob/v2.0.1/LICENSE
71+
72+
----------
73+
Module: gopkg.in/yaml.v3
74+
Version: v3.0.1
75+
License: MIT
76+
License URL: https://github.com/go-yaml/yaml/blob/v3.0.1/LICENSE
4777

4878

‎README.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2+
![GitHub Workflow Status](https://github.com/codesphere-cloud/cs-go/actions/workflows/build.yml/badge.svg)
3+
14
# Codesphere Go SDK & CLI
25

36
Seemlessly integrate CS into your local development flow.
@@ -28,4 +31,11 @@ CS_WORKSPACE_ID - workspace ID to target, get from environment in Web IDE
2831
CS_API - API url of codesphere, defaults to https://codesphere.com/api
2932
```
3033

31-
### Go SDK
34+
## Go SDK
35+
36+
37+
38+
## Community & Contributions
39+
40+
Please review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand our community expectations.
41+
We welcome contributions! All contributions to this project must be made in accordance with the Developer Certificate of Origin (DCO). See our full [Contributing Guidelines](CONTRIBUTING.md) for details.

‎api/api_suite_test.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) Codesphere Inc.
2+
// SPDX-License-Identifier: Apache-2.0
3+
14
package api_test
25

36
import (

0 commit comments

Comments
 (0)