Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Style Guide proposal #287

Merged
merged 3 commits into from
Jan 2, 2024
Merged

Style Guide proposal #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0478cd1
docs: cli style guide first draft
Tinyblargon Dec 6, 2023
3eb3244
docs: sdk style guide first draft
Tinyblargon Dec 6, 2023
40a8682
docs:
Tinyblargon Dec 6, 2023
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Proxmox API in golang. For /api2/json. Work in progress.

Starting with Proxmox 5.2 you can use cloud-init options.

## Contributing

Want to help with the project please refer to our [style-guide](docs/style-guide/style-guide.md).

## Build

```sh
Expand Down
9 changes: 9 additions & 0 deletions docs/style-guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Command LIne Interface

When this document referrers to the Command LIne Interface (CLI) it references the code in the [/cli](../../cli/) directory.

<!-- TODO Add more info.-->

## Anti Patterns

The code in [main.go](../../main.go) is deprecated and should not be added to. Instead, add new commands to the new CLI.
Loading
Loading