Skip to content

Commit 86e32a4

Browse files
outscale-rceoutscale-rce
committed
📝 docs: Adding missing files from template
1 parent 5cd45f3 commit 86e32a4

6 files changed

Lines changed: 245 additions & 28 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug Report
2+
description: Report a reproducible bug or regression
3+
labels: [bug]
4+
assignees: []
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to report this bug! Please fill in as much detail as possible.
11+
12+
- type: input
13+
id: title
14+
attributes:
15+
label: Bug Summary
16+
description: A short summary of the bug
17+
placeholder: e.g., Crash on startup
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: steps
23+
attributes:
24+
label: Steps to Reproduce
25+
description: Describe the steps needed to reproduce the issue
26+
placeholder: |
27+
1. Open a terminal
28+
2. Run: `my-cli-tool init --config config.yaml`
29+
3. Run: `my-cli-tool deploy`
30+
4. Observe the error in the output
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: expected
36+
attributes:
37+
label: Expected Behavior
38+
description: What did you expect to happen?
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened?
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: version
52+
attributes:
53+
label: Project Version
54+
description: What version are you using?
55+
placeholder: e.g., v1.2.3
56+
57+
- type: textarea
58+
id: environment
59+
attributes:
60+
label: Environment Info
61+
description: Include OS, language/runtime, configuration, etc.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Ask a Question or Get Help
4+
url: https://discord.gg/HUVtY5gT6s
5+
about: Join our Discord server to ask questions and connect with the maintainers.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
labels: [enhancement]
4+
assignees: []
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Have a feature in mind? Let us know how it would help!
11+
12+
- type: input
13+
id: title
14+
attributes:
15+
label: Feature Summary
16+
description: A short and clear title for your feature
17+
placeholder: e.g., Add support for `--dry-run` flag in deploy command
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: problem
23+
attributes:
24+
label: Problem to Solve
25+
description: What problem does this feature solve?
26+
27+
- type: textarea
28+
id: solution
29+
attributes:
30+
label: Proposed Solution
31+
description: How do you imagine this feature would work?
32+
33+
- type: textarea
34+
id: alternatives
35+
attributes:
36+
label: Alternatives Considered
37+
description: Have you tried another approach or workaround?
38+
39+
- type: textarea
40+
id: context
41+
attributes:
42+
label: Additional Context
43+
description: Add any other context or related links.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# 📦 Pull Request Template
2+
3+
## Description
4+
5+
Please include a summary of the changes and the related context. If this is a feature, explain the motivation. If it's a bug fix, describe what was broken.
6+
7+
Fixes: #<issue-number> _(if applicable)_
8+
9+
## Type of Change
10+
11+
Please check the relevant option(s):
12+
13+
- [ ] 🐛 Bug fix
14+
- [ ] ✨ New feature
15+
- [ ] 🧹 Code cleanup or refactor
16+
- [ ] 📝 Documentation update
17+
- [ ] 🔧 Build or CI-related change
18+
- [ ] 🔒 Security fix
19+
- [ ] Other (specify):
20+
21+
## How Has This Been Tested?
22+
23+
Please describe the test strategy:
24+
25+
- [ ] Manual testing
26+
- [ ] Unit tests
27+
- [ ] Integration tests
28+
- [ ] Not tested yet
29+
30+
Commands used (if applicable):
31+
32+
```bash
33+
# Example
34+
my-cli-tool build --verbose
35+
my-cli-tool test
36+
````
37+
38+
## Checklist
39+
40+
* [ ] I have followed the [Contributing Guidelines](../blob/main/CONTRIBUTING.md)
41+
* [ ] I have added tests or explained why they are not needed
42+
* [ ] I have updated relevant documentation (README, examples, etc.)
43+
* [ ] My changes follow the [Conventional Commits](https://www.conventionalcommits.org/) specification
44+
* [ ] My commits include appropriate [Gitmoji](https://gitmoji.dev/)
45+
46+
## Additional Context
47+
48+
Add any additional context or screenshots if necessary.

‎CODE_OF_CONDUCT.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Code of Conduct
2+
3+
This project follows the [Contributor Covenant](https://www.contributor-covenant.org) Code of Conduct.
4+
5+
## Our Pledge
6+
7+
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.
8+
9+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
10+
11+
## Our Standards
12+
13+
Examples of behavior that contributes to a positive environment include:
14+
15+
- Demonstrating empathy and kindness
16+
- Being respectful of differing viewpoints and experiences
17+
- Giving and gracefully accepting constructive feedback
18+
- Taking responsibility and apologizing to those affected by mistakes
19+
- Focusing on what is best for the community
20+
21+
Examples of unacceptable behavior include:
22+
23+
- The use of sexualized language or imagery
24+
- Trolling, insulting, or derogatory comments
25+
- Public or private harassment
26+
- Publishing others’ private information without explicit permission
27+
- Other conduct which could reasonably be considered inappropriate
28+
29+
## Enforcement Responsibilities
30+
31+
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.
32+
33+
## Reporting
34+
35+
If you experience or witness unacceptable behavior, please report it via one of the following channels:
36+
37+
- 💬 [Discord](https://discord.gg/HUVtY5gT6s)
38+
- 📧 [[email protected]](mailto:[email protected])
39+
40+
Reports will be handled confidentially and reviewed promptly.
41+
42+
## Attribution
43+
44+
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).

‎CONTRIBUTING.md‎

Lines changed: 44 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,56 @@
1-
## How to submit a contribution
1+
# Contributing Guidelines
22

3-
Thank you for considering contributing to osc_sdk_python.
3+
First off, thank you for taking the time to contribute! 🙌
4+
Your help is appreciated and helps make this project better for everyone.
45

5-
Potential contributions include:
6+
---
67

7-
- Reporting and fixing bugs.
8-
- Requesting features.
9-
- Adding features.
10-
- Cleaning up the code.
11-
- Improving the documentation.
8+
## How to Contribute
129

13-
In order to report bugs or request features, search the issue tracker to check for a duplicate.
10+
### 🐛 Reporting Bugs
11+
If you find a bug, please open an issue and include:
12+
- A clear and descriptive title
13+
- Steps to reproduce the issue
14+
- Expected and actual behavior
15+
- Any relevant logs, screenshots, or environment information
1416

15-
It’s totally acceptable to create an issue when you’re unsure whether
16-
something is a bug or not. We’ll help you figure it out.
17+
### ✨ Suggesting Enhancements
18+
Have an idea for a new feature or improvement?
19+
- Open an issue and describe your suggestion
20+
- Explain the use case and potential benefits
21+
- Optional: propose an implementation strategy
1722

18-
Use the same issue tracker to report problems with the documentation.
23+
### 🛠️ Submitting Code Changes
24+
To submit a patch or enhancement:
25+
1. Fork the repository
26+
2. Create a new branch (`git checkout -b feature/your-feature-name`)
27+
3. Make your changes
28+
4. Test your changes (if applicable)
29+
5. Open a pull request with a clear description of your changes
1930

20-
## Pull Requests
31+
### ✅ Code of Conduct
32+
By participating, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
2133

22-
We’ll do our best to review your pull request (or “PR” for short) quickly.
34+
---
2335

24-
Each PR should, as much as possible, address just one issue and be self-contained.
25-
Smaller the set of changes in the pull request is, the quicker it can be reviewed and
26-
merged - if you have ten small, unrelated changes, then go ahead and submit ten PRs.
36+
## Guidelines
2737

28-
Make sure to run tests/run.sh before each PR.
38+
- Keep pull requests focused and atomic (one feature or fix per PR).
39+
- Follow any existing code style or formatting conventions.
40+
- Document your code where necessary.
41+
- Include tests when adding new logic (if applicable).
42+
- Use clear, meaningful commit messages (optionally following [Conventional Commits](https://www.conventionalcommits.org/) and using [Gitmoji](https://gitmoji.dev/) for added clarity and consistency).
2943

30-
## How to release
44+
## 📝 Commit Template
3145

32-
- Update version in:
33-
- [osc_sdk_python/VERSION](osc_sdk_python/VERSION)
34-
- [README.md](README.md)
35-
- Commit, PR, merge
36-
- Create release in Github
37-
- Github action should have generated artifacts. If not:
38-
- `make package`
39-
- Add `dist/osc_sdk_python-x.x.x-py3-none-any.whl` and `osc_sdk_python-x.x.x.tar.gz` files to release.
40-
- Setup PIP_TOKEN and run `make upload-package`
46+
To help you follow the Gitmoji and Conventional Commit format, you can enable the local commit template:
47+
48+
```bash
49+
git config commit.template .github/commit-template.txt
50+
```
51+
52+
---
53+
54+
## Questions?
55+
56+
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).

0 commit comments

Comments
 (0)