Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .NOTICE.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Codesphere Go SDK & CLI
Copyright (c) Codesphere Inc.

This project includes code licensed under the following terms:
{{ range . }} {{ if eq .Name "github.com/codesphere-cloud/oms" }} {{ continue }} {{ end }}
----------
Module: {{ .Name }}
Version: {{ .Version }}
License: {{ .LicenseName }}
License URL: {{ .LicenseURL }}
{{ end }}

15 changes: 15 additions & 0 deletions .copywrite.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
schema_version = 1

project {
license = "Apache-2.0"
copyright_year = 2025
copyright_holder = "Codesphere Inc."

# (OPTIONAL) A list of globs that should not have copyright/license headers.
# Supports doublestar glob patterns for more flexibility in defining which
# files or folders should be ignored
header_ignore = [
# "vendor/**",
# "**autogen**",
]
}
5 changes: 5 additions & 0 deletions .github/dco.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

require:
members: false
3 changes: 3 additions & 0 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) Codesphere Inc.
# SPDX-License-Identifier: Apache-2.0

version: 2

before:
Expand Down
133 changes: 133 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

132 changes: 132 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributing to Codesphere OMS

We welcome contributions of all kinds! By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

## How to Report Issues

If you encounter a bug or have a feature request, please [open a new issue](https://github.com/codesphere-cloud/oms/issues/new) on GitHub. Please include the following information:

* **Operating System and Version:**
* **OMS Version (if applicable):**
* **Steps to Reproduce the Bug:**
* **Expected Behavior:**
* **Actual Behavior:**
* **Any relevant logs or error messages:**

## How to Suggest Features or Improvements

We'd love to hear your ideas! Please [open a new issue](https://github.com/codesphere-cloud/oms/issues/new) to discuss your proposed feature or improvement before submitting code. This allows us to align on the design and approach.

## How to Add a New Subcommand to the CLI

This project currently uses a fork of cobra-cli with locally-scoped variables: https://github.com/NautiluX/cobra-cli-local.

Please use it to add new commands to the OMS CLI like following:

```
cobra-cli add -c false -L -d cli -p install component
```

Run the generated `AddInstallComponent()` function in the parent `cli/cmd/install.go` to add the subcommand.
This will add the following command to the CLI:

```
oms-cli install component
```

## Contributing Code

If you'd like to contribute code, please follow these steps:

1. **Fork the Repository:** Fork this repository to your GitHub account.
2. **Create a Branch:** Create a new branch for your changes: `git checkout -b feature/your-feature-name`
3. **Set Up Development Environment:**

* Ensure you have Go installed. The minimum required Go version is specified in the `go.mod` file.
* Clone your forked repository: `git clone git@github.com:your-username/oms.git`
* Navigate to the project directory: `cd oms`
* Run `make`: This command should download necessary dependencies and build the CLI.

4. **Follow Coding Standards:**

* Please ensure your code is properly formatted using `go fmt`.
* We use [golangci-lint](https://golangci-lint.run/) for static code analysis. Please run it locally before submitting a pull request: `make lint`.

5. **Write Tests:**

* We use [Ginkgo](https://github.com/onsi/ginkgo) and [Gomega](https://github.com/onsi/gomega) for testing.
* Please write tests for your code using Ginkgo and Gomega and add them to the `_test.go` files.
* Aim for good test coverage.

6. **Build and Test:**

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

7. **Commit Your Changes:**

* 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:
* `fix(api): Handle edge case in API client`
* `feat(cli): Add new command for listing resources`
* `docs: Update contributing guide with commit message conventions`
* **Developer Certificate of Origin (DCO)**

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.

```text
Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(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

(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, or solely by me; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(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) is maintained indefinitely
and may be redistributed consistent with this project or the
open source license(s) involved.
```

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:

```
Fix: Handle edge case in API client

This commit fixes a bug where the API client would crash when receiving
an empty response.

Signed-off-by: John Doe <john.doe@example.com>
```

You can add this line to your commit message using the `-s` flag with the `git commit` command:

```bash
git commit -s -m "Your commit message"
```

8. **Submit a Pull Request:** [Open a new pull request](https://github.com/codesphere-cloud/oms/compare) to the `main` branch of this repository. Please include a clear description of your changes and reference any related issues.

## Code Review Process

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.

## License

By contributing to Codesphere OMS, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).

## Community

Connect with the community and ask questions by joining our mailing list: [oms@codesphere.com](mailto:oms@codesphere.com).

Thank you for your interest in contributing to Codesphere OMS!
Loading