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
44 changes: 44 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Code of Conduct

This project follows the [Contributor Covenant](https://www.contributor-covenant.org) Code of Conduct.

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our project and 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, 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 include:

- Demonstrating empathy and kindness
- Being respectful of differing viewpoints and experiences
- Giving and gracefully accepting constructive feedback
- Taking responsibility and apologizing to those affected by mistakes
- Focusing on what is best for the community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery
- Trolling, insulting, or derogatory comments
- Public or private harassment
- Publishing others’ private information without explicit permission
- Other conduct which could reasonably be considered inappropriate

## Enforcement Responsibilities

Project maintainers are responsible for clarifying and enforcing this code of conduct and will take appropriate and fair corrective action in response to any behavior they deem inappropriate.

## Reporting

If you experience or witness unacceptable behavior, please report it via one of the following channels:

- 💬 [Discord](https://discord.gg/HUVtY5gT6s)
- 📧 [opensource@outscale.com](mailto:opensource@outscale.com)

Reports will be handled confidentially and reviewed promptly.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
67 changes: 63 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,66 @@
# Hacking Outscale SDK
# Contributing to oapi-cli

SDK itself is generated from Outscale's [COGNAC](https://github.com/outscale/COGNAC) using [osc-api](https://github.com/outscale/osc-api) description.
Thank you for considering contributing to **oapi-cli**!
We welcome contributions from everyone—whether it's reporting bugs, writing tests, improving documentation, or suggesting new features.

This mean that pull request providing change to code would be automatically overwritten in next [osc-api].
---

## 🧑‍💻 How to Contribute

### 🐛 Bug Reports

- Clearly describe the issue.
- Include reproduction steps and environment details.
- If possible, provide a minimal failing example.

### ✨ Feature Requests

- Explain your use case.
- Provide context and expected behavior.
- Be open to feedback or refinement.

### 📘 Documentation

- Improvements to `README.md`, `variable.md`, or command examples are always helpful.
- Keep the tone consistent with other OUTSCALE projects.

### 🧪 Tests

- Adding tests to cover more scenarios is appreciated.

---

## 📦 Pull Requests

Please follow these guidelines:

- Keep changes focused and scoped to a single purpose.
- Run the CLI and validate behavior before submitting.
- Use clear and descriptive commit messages.
- Link related issues in your PR description.

> ⚠️ **Do not modify SDK-generated code manually. See below.**

---

## 🧠 Hacking Outscale SDK

The SDK used in this project is **generated automatically** using [Outscale's COGNAC](https://github.com/outscale/COGNAC) tool and the [osc-api](https://github.com/outscale/osc-api) specification.

This means:

- **Pull requests that change the generated SDK code will be overwritten** the next time we regenerate from `osc-api`.

We **do** welcome contributions such as:

- Feature suggestions
- CLI examples
- Documentation improvements
- Tests and usage validation

---

## Questions?

If you have any questions or need help, feel free to [open an issue](../../issues) or reach out to the maintainers on [Discord](https://discord.gg/HUVtY5gT6s).

Other contributions like examples, issue and tests are welcome!
Loading