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

Update Issue and PR Templates #66

Merged
merged 1 commit into from
Feb 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
name: Bug
about: Use this template if an implementation provides incorrect results or causes crashes.
about: Report an error, performance issue or unexpected behaviour.
labels: "type:bug"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Description:
<!-- Add a brief description -->
<!-- Describe your issue here -->


#### How to replicate:
<!-- Describe a routine that allows developers to replicate the issue -->
#### Steps to reproduce:
<!-- Please tell us how to reproduce this issue -->


#### Expected behaviour:
<!-- What result would you expect from the fix? -->


#### Test file(s):
<!-- Link to test files to validate the proposed changes -->
<!-- Link to test files to help reproduce the bug and validate the proposed fixes -->
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: Feature Request
about: Use this template to request a functionality that doesn't exist yet or is only partially implemented.
about: Suggest ideas for new functionality, or enhancement of existing.
labels: "type:feature"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Description:
<!-- Add a brief description of what functionality is missing, including sufficient details of expected behaviour -->
<!-- Describe your idea. Including details of the intended functionality, expected behaviour and desired inputs and outputs -->



11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/02_test_script.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Test Script
about: Creation of a unit test is required to check functionality, test use cases or validity of a specific part of the code.
labels: "type:test-script"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Definition of the test :
<!-- Please describe the test, including the proposed scope and range of input parameters -->
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
name: Documentation
about: Use this template to report missing or incorrect documentation in the code or in the wiki.
about: Highlight missing or incorrect documentation in the code or in the website and wiki.
labels: "type:documentation"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Describe the documentation issue:
- [ ] The code - the attribute of a method or class
- [ ] The wiki

#### What is missing/incorrect?
<!-- Details of desired documentation? -->
<!-- Details of desired documentation -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Compliance
about: Use this template to report code that doesn't follow the guidelines.
about: Report code that doesn't follow the BHoM guidelines.
labels: "type:compliance"

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
---
name: External API changes
about: Use this template if the code requires modification due to api changes of any referenced library. Including other BHoM dlls
name: External API Changes
about: Modifications to the code are required due to changes to the API of a referenced library. This includes changes imposed from references to other BHoM projects.
labels: "type:external-api-changes"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Parent issue(s) or Pull Request(s) causing the changes:
<!-- If appropriate please reference the url of any other issue(s) that forces the current change-->
<!-- Note: that this is usually a change in an external API -->
<!-- If appropriate please reference the URL of any other issue(s) that forces the current change-->

#

#### Description:
<!-- Add a brief description -->
<!-- Add a brief description of the changes required -->


#### Test file(s):
Expand Down
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/06_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Question
about: Ask a question about any aspect of the BHoM code or toolkits. Equally do feel free to reach out on Slack with queries and for wider discussions. Link and open invite can be found on https://bhom.xyz
labels: "type:question"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->


<!-- If you would like to ask a question on Slack you can find a link and open invite on https://bhom.xyz -->
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/test_script.md

This file was deleted.

File renamed without changes.