From bcf570852ae73bc1afc8f03e47ef094e52b32cb5 Mon Sep 17 00:00:00 2001 From: Matsvei Pahotski Date: Mon, 17 Feb 2025 19:18:38 +0100 Subject: [PATCH 1/2] #5 Add contribution guidelines --- .github/ISSUE_TEMPLATE/bug-report.yml | 54 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/new-feature.yml | 36 +++++++++++++++++ CONTRIBUTING.md | 52 +++++++++++++++++++++++++ 4 files changed, 143 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/new-feature.yml create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..d02c68b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml new file mode 100644 index 0000000..24ee489 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,36 @@ +name: New feature +description: Suggest or request a new feature +labels: ["enhancement"] +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: A button in the screen X 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 or screenshots 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 see together if it can be implemented. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1984845 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 + ``` + +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 #\. + + Then, push your branch to your forked repository. + ``` + git add . + git commit -m "# Fix commit message" + git push origin + ``` +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. From 9e0fd1b4127f802b7caa0fb4d447abe69ffaa8b6 Mon Sep 17 00:00:00 2001 From: Matsvei Pahotski Date: Mon, 17 Feb 2025 19:55:25 +0100 Subject: [PATCH 2/2] #5 Fix feature request proposal template --- .github/ISSUE_TEMPLATE/new-feature.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml index 24ee489..b4dbb27 100644 --- a/.github/ISSUE_TEMPLATE/new-feature.yml +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -1,6 +1,7 @@ -name: New feature +name: Feature request description: Suggest or request a new feature labels: ["enhancement"] +assignees: ["MPogotsky"] body: - type: markdown attributes: @@ -10,7 +11,7 @@ body: id: description attributes: label: Describe the feature - placeholder: A button in the screen X that allows to do Y + placeholder: New method in xapi client that allows to do Y validations: required: true - type: textarea @@ -23,7 +24,7 @@ body: attributes: label: Additional context placeholder: | - Add any other context or screenshots about the feature request here. + Add any other context about the feature request here - type: dropdown id: assign attributes: @@ -33,4 +34,4 @@ body: - type: markdown attributes: value: | - Thanks for your suggestion! Let's see together if it can be implemented. + Thanks for your suggestion! Let`s discuss how it can be implemented