Skip to content
This repository was archived by the owner on Apr 1, 2025. It is now read-only.

Commit bcf5708

Browse files
committed
#5 Add contribution guidelines
1 parent f3ac73f commit bcf5708

File tree

4 files changed

+143
-0
lines changed

4 files changed

+143
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug Report
2+
description: Report a bug
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: dropdown
10+
id: version
11+
attributes:
12+
label: Version of xapi-cpp
13+
description: In which version of xapi-cpp did this bug occur?
14+
options:
15+
- v1.0.1
16+
- v1.0.0
17+
default: 0
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: operating-system
22+
attributes:
23+
label: Operating system used
24+
description: On which operating system and version did you encounter this bug?
25+
placeholder: e.g., Windows 10, macOS Ventura, Ubuntu 20.04
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: steps
30+
attributes:
31+
label: Steps to reproduce
32+
description: Detailed steps on how to trigger the bug
33+
placeholder: please provide descrition, code snippets and so on
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: expected
38+
attributes:
39+
label: Expected Behavior
40+
placeholder: I expected this to happen
41+
- type: textarea
42+
id: error-logs
43+
attributes:
44+
label: Put here any logs (optional)
45+
- type: dropdown
46+
id: assign
47+
attributes:
48+
label: "Would you like to work on this issue?"
49+
options:
50+
- "Yes"
51+
- type: markdown
52+
attributes:
53+
value: |
54+
Thanks for reporting this issue! We will get back to you as soon as possible.

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: New feature
2+
description: Suggest or request a new feature
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please fill out the sections below to properly describe the new feature you are suggesting.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Describe the feature
13+
placeholder: A button in the screen X that allows to do Y
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: rationale
18+
attributes:
19+
label: It should be implemented because
20+
placeholder: It will allow to do Y that is needed for Z
21+
- type: textarea
22+
id: context
23+
attributes:
24+
label: Additional context
25+
placeholder: |
26+
Add any other context or screenshots about the feature request here.
27+
- type: dropdown
28+
id: assign
29+
attributes:
30+
label: "Would you like to work on this issue?"
31+
options:
32+
- "Yes"
33+
- type: markdown
34+
attributes:
35+
value: |
36+
Thanks for your suggestion! Let's see together if it can be implemented.

CONTRIBUTING.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to xapi-cpp
2+
Thank you for your interest in contributing to **xapi-cpp**!
3+
This document outlines the guidelines for contributing, making it a smooth and collaborative experience for everyone.
4+
5+
## How Can I Contribute?
6+
7+
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).
8+
9+
## Contributing Workflow
10+
11+
1. **Fork the repository**
12+
2. **Clone the repository**
13+
3. **Create a new branch**
14+
15+
Create a new branch for your changes. Use a descriptive branch name.
16+
```
17+
git checkout -b <branch-name>
18+
```
19+
20+
4. **Make your changes**
21+
22+
Implement your changes in the codebase. This might involve adding new features, fixing bugs, or improving documentation.
23+
24+
5. **Test your changes!**
25+
26+
Thoroughly test your changes to ensure they work as expected and don't introduce any regressions. Refer to our Testing Guidelines for specific instructions.
27+
28+
6. **Commit and push your changes**
29+
30+
Stage your changes and commit them with a clear and concise commit message.
31+
32+
If you are solving issue from issue list, please, start you commit with #\<issue number\>.
33+
34+
Then, push your branch to your forked repository.
35+
```
36+
git add .
37+
git commit -m "#<issue number> Fix commit message"
38+
git push origin <branch-name>
39+
```
40+
7. **Create a pull request to master branch**
41+
42+
Create a pull request targeting the ```main``` branch.
43+
44+
8. **Wait for the pull request to be reviewed and merged**
45+
46+
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.
47+
48+
Thank you for your contribution!
49+
50+
51+
## Contact
52+
Feel free to reach out via email at matsvei.pahotski@gmail.com if you need direct assistance.

0 commit comments

Comments
 (0)