Skip to content
This repository was archived by the owner on Apr 1, 2025. It is now read-only.
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
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Bug Report
description: Report a bug
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: version
attributes:
label: Version of xapi-cpp
description: In which version of xapi-cpp did this bug occur?
options:
- v1.0.1
- v1.0.0
default: 0
validations:
required: true
- type: textarea
id: operating-system
attributes:
label: Operating system used
description: On which operating system and version did you encounter this bug?
placeholder: e.g., Windows 10, macOS Ventura, Ubuntu 20.04
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Detailed steps on how to trigger the bug
placeholder: please provide descrition, code snippets and so on
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
placeholder: I expected this to happen
- type: textarea
id: error-logs
attributes:
label: Put here any logs (optional)
- type: dropdown
id: assign
attributes:
label: "Would you like to work on this issue?"
options:
- "Yes"
- type: markdown
attributes:
value: |
Thanks for reporting this issue! We will get back to you as soon as possible.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Suggest or request a new feature
labels: ["enhancement"]
assignees: ["MPogotsky"]
body:
- type: markdown
attributes:
value: |
Please fill out the sections below to properly describe the new feature you are suggesting.
- type: textarea
id: description
attributes:
label: Describe the feature
placeholder: New method in xapi client that allows to do Y
validations:
required: true
- type: textarea
id: rationale
attributes:
label: It should be implemented because
placeholder: It will allow to do Y that is needed for Z
- type: textarea
id: context
attributes:
label: Additional context
placeholder: |
Add any other context about the feature request here
- type: dropdown
id: assign
attributes:
label: "Would you like to work on this issue?"
options:
- "Yes"
- type: markdown
attributes:
value: |
Thanks for your suggestion! Let`s discuss how it can be implemented
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contributing to xapi-cpp
Thank you for your interest in contributing to **xapi-cpp**!
This document outlines the guidelines for contributing, making it a smooth and collaborative experience for everyone.

## How Can I Contribute?

To report a bug, request a new feature, or contribute code, please use GitHub issues with the provided issue templates. You can open a new issue [here](https://github.com/MPogotsky/xapi-cpp/issues).

## Contributing Workflow

1. **Fork the repository**
2. **Clone the repository**
3. **Create a new branch**

Create a new branch for your changes. Use a descriptive branch name.
```
git checkout -b <branch-name>
```

4. **Make your changes**

Implement your changes in the codebase. This might involve adding new features, fixing bugs, or improving documentation.

5. **Test your changes!**

Thoroughly test your changes to ensure they work as expected and don't introduce any regressions. Refer to our Testing Guidelines for specific instructions.

6. **Commit and push your changes**

Stage your changes and commit them with a clear and concise commit message.

If you are solving issue from issue list, please, start you commit with #\<issue number\>.

Then, push your branch to your forked repository.
```
git add .
git commit -m "#<issue number> Fix commit message"
git push origin <branch-name>
```
7. **Create a pull request to master branch**

Create a pull request targeting the ```main``` branch.

8. **Wait for the pull request to be reviewed and merged**

Your pull request will be reviewed by project maintainers. Address any feedback or requested changes. Once approved, your pull request will be merged into the main branch.

Thank you for your contribution!


## Contact
Feel free to reach out via email at matsvei.pahotski@gmail.com if you need direct assistance.