Skip to content

Commit

Permalink
docs: working on contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
klonyyy committed May 5, 2024
1 parent 70872a9 commit 4b349ed
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 24 deletions.
3 changes: 1 addition & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ A good bug report shouldn't leave others needing to chase you up for more inform
### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/klonyyy/STMViewer/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

Expand All @@ -45,7 +44,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/klonyy
- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to.
- **Explain why this enhancement would be useful** to most STMViewer users. You may also want to point out the other projects that solved it better and which could serve as inspiration.


Expand Down
24 changes: 2 additions & 22 deletions .github/ISSUE_TEMPLATE/issue_template.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
name: "Ask a question, report a bug, request a feature, etc."
description: "Ask any question, discuss best practices, report a bug, request a feature."
body:
- type: markdown
attributes:
value: |
**Prerequisites:**
- I have read [Contributing Guidelines](https://github.com/klonyyy/STMViewer/blob/devel/.github/CONTRIBUTING.md).
----
- type: input
id: specs_version
attributes:
label: "STMViewer Version/Branch:"
value: "Version 0.X.Y, Branch: XXX (main/devel/etc.)"
placeholder: "Version 1.XX, Branch: XXX (master/docking/etc.)"
placeholder: "Version 0.4.0, Branch: main"
validations:
required: true
- type: input
Expand All @@ -37,7 +29,7 @@ body:
value: |
**My Issue/Question:**
XXX _(please provide as much context as possible)_
Please provide as much context as possible
validations:
required: true
- type: textarea
Expand All @@ -48,15 +40,3 @@ body:
placeholder: "(Drag files here)"
validations:
required: false
- type: textarea
id: repro_code
attributes:
label: "Minimal, Complete and Verifiable Example code:"
description: "Provide a step by step "
value: |
1. Run STMViewer
2. Click X
3. Select Y
4. ...
validations:
required: false

0 comments on commit 4b349ed

Please sign in to comment.