Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update of the issue and PR templates #330

Merged
merged 2 commits into from
Nov 30, 2023

Conversation

o-kopysov
Copy link
Collaborator

Description

I prefer to update issues and pull request templates. This PR is aimed to update and improve all the templates used in the project.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality not to work as expected)
  • Code cleanup/refactoring
  • Documentation update
  • This change requires a documentation update
  • CI system update
  • Test Coverage update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
@o-kopysov o-kopysov added the documentation Improvements or additions to documentation label Nov 29, 2023
@o-kopysov o-kopysov added this to the v1.3.0 milestone Nov 29, 2023
@o-kopysov o-kopysov self-assigned this Nov 29, 2023
Comment on lines 11 to 46
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. For example, "I'm always frustrated when..."

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Steps to Reproduce:**
1. Step 1
2. Step 2
3. ...

**Expected Behavior:**
A clear and concise description of what you expected to happen.

**Additional Information:**
Add any other context, details, or relevant information about the issue.

**Due Date:**
Specify the due date for this issue.

**Attachments:**
Attach any relevant files or screenshots.

**Checklist:**
- [ ] Checklist item 1
- [ ] Checklist item 2
- [ ] ...

**Related Issues:**
Reference any related issues or pull requests.

**Environment:**
Specify the relevant details about the environment in which the issue occurs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems a collection of Bug Report and Feature Reqeust to me. If there is no clear purpose, what about empty this easy to write down?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... I don't think that we need a template for the empty issue because it's available by default.
image

So, I will remove the custom template.

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
Copy link
Member

@tiokim tiokim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@o-kopysov o-kopysov merged commit 1776696 into Samsung:main Nov 30, 2023
7 checks passed
@o-kopysov o-kopysov deleted the template branch November 30, 2023 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants