finos / kdb-studio

Studio for kdb+ / Rapid execution environment for q
Apache License 2.0
18 stars 12 forks source link

Add FINOS GitHub Issue Templates from FINOS Project Blueprint #13

Closed mcleo-d closed 4 years ago

mcleo-d commented 4 years ago

Description

This pull request adds three FINOS Issues Templates to the .github/ISSUE_TEMPLATE folder of the kdb-studio project to enable Bug Reporting, Feature Requests and Support Questions to be raised by the kdb-studio community.

These Issue templates are accessed via the New issue button featured on the kdb-studio issues page : https://github.com/finos/kdb-studio/issues

Bug Report

File : Bug_report.md

---
name: 🐛 Bug Report
about: If something isn't working as expected 🤔.
---

## Bug Report

### Steps to Reproduce:
 1. ...step 1 description...
 2. ...step 2 description...
 3. ...step 3 description...

### Expected Result:
...description of what you expected to see...

### Actual Result:
...what actually happened, including full exceptions (please include the entire stack trace, including "caused by" entries), log entries, screen shots etc. where appropriate...

### Environment:
...version and build of the project, OS and runtime versions, virtualised environment (if any), etc. ...

### Additional Context:
...add any other context about the problem here. If applicable, add screenshots to help explain...

Feature Request

File : Feature_request.md

---
name: 🚀 Feature Request
about: I have a suggestion (and may want to implement it 🙂)!
---

## Feature Request

### Description of Problem:
...what *problem* are you trying to solve that the project doesn't currently solve?

...please resist the temptation to describe your request in terms of a solution.  Job Story form ("When [triggering condition], I want to [motivation/goal], so I can [outcome].") can help ensure you're expressing a problem statement.

### Potential Solutions:
...clearly and concisely describe what you want to happen. Add any considered drawbacks.

... if you've considered alternatives, clearly and concisely describe those too.

Support Question

File : Support_question.md

---
name: 🤗 Support Question
about: If you have a question about configuration, usage, etc. 💬
---

## Support Question

...ask your question here.

...be sure to search existing issues since someone might have already asked something similar.