Просмотр исходного кода

Introduced purpose-specific GitHub issue templates

Jeremy Stretch 7 лет назад
Родитель
Сommit
431361efad

+ 0 - 49
.github/ISSUE_TEMPLATE.md

@@ -1,49 +0,0 @@
-<!--
-    Before opening a new issue, please search through the existing issues to
-    see if your topic has already been addressed. Note that you may need to
-    remove the "is:open" filter from the search bar to include closed issues.
-
-    Check the appropriate type for your issue below by placing an x between the
-    brackets. For assistance with installation issues, or for any other issues
-    other than those listed below, please raise your topic for discussion on
-    our mailing list:
-
-        https://groups.google.com/forum/#!forum/netbox-discuss
-
-    Please note that issues which do not fall under any of the below categories
-    will be closed. Due to an excessive backlog of feature requests, we are
-    not currently accepting any proposals which extend NetBox's feature scope.
-
-    Do not prepend any sort of tag to your issue's title. An administrator will
-    review your issue and assign labels as appropriate.
---->
-### Issue type
-[ ] Feature request <!-- An enhancement of existing functionality -->
-[ ] Bug report      <!-- Unexpected or erroneous behavior -->
-[ ] Documentation   <!-- A modification to the documentation -->
-[ ] Housekeeping    <!-- Changes pertaining to the codebase itself -->
-
-<!--
-    Please describe the environment in which you are running NetBox. (Be sure
-    to verify that you are running the latest stable release of NetBox before
-    submitting a bug report.) If you are submitting a bug report and have made
-    any changes to the code base, please first validate that your bug can be
-    recreated while running an official release.
--->
-### Environment
-* Python version:  <!-- Example: 3.5.4 -->
-* NetBox version:  <!-- Example: 2.3.5 -->
-
-<!--
-    BUG REPORTS must include:
-        * A list of the steps needed for someone else to reproduce the bug
-        * A description of the expected and observed behavior
-        * Any relevant error messages (screenshots may also help)
-
-    FEATURE REQUESTS must include:
-        * A detailed description of the proposed functionality
-        * A use case for the new feature
-        * A rough description of any necessary changes to the database schema
-        * Any relevant third-party libraries which would be needed
--->
-### Description

+ 34 - 0
.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: :bug: Bug Report
+about: Report a reproducible bug in the current release of NetBox
+---
+
+<!--
+    NOTE: This form is only for reproducible bugs. If you need assistance with
+    NetBox installation, or if you have a general question, DO NOT open an
+    issue. Instead, post to our mailing list:
+
+        https://groups.google.com/forum/#!forum/netbox-discuss
+
+    Please describe the environment in which you are running NetBox. Be sure
+    that you are running an unmodified instance of the latest stable release
+    before submitting a bug report.
+-->
+### Environment
+* Python version:  <!-- Example: 3.5.4 -->
+* NetBox version:  <!-- Example: 2.3.6 -->
+
+<!--
+    Describe in detail the steps that someone else can take to reproduce this
+    bug using the current stable release of NetBox (or the current beta release
+    where applicable).
+-->
+### Steps to Reproduce
+
+
+<!-- What did you expect to happen? -->
+### Expected Behavior
+
+
+<!-- What happened instead? -->
+### Observed Behavior

+ 17 - 0
.github/ISSUE_TEMPLATE/documentation_change.md

@@ -0,0 +1,17 @@
+---
+name: :book: Documentation Change
+about: Suggest an addition or modification to the NetBox documentation
+---
+
+<!--
+    Please indicate the nature of the change by placing an X in one of the
+    boxes below.
+-->
+### Change Type
+[ ] Addition
+[ ] Correction
+[ ] Deprecation
+[ ] Cleanup (formatting, typos, etc.)
+
+<!-- Describe the proposed change(s). -->
+### Proposed Changes

+ 53 - 0
.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,53 @@
+---
+name: :new: Feature Request
+about: Propose a new NetBox feature or enhancement
+---
+
+<!--
+    NOTE: This form is only for proposing specific new features or enhancements.
+    If you have a general idea or question, please post to our mailing list
+    instead of opening an issue:
+
+        https://groups.google.com/forum/#!forum/netbox-discuss
+
+    NOTE: Due to an excessive backlog of feature requests, we are not currently
+    accepting any proposals which significantly extend NetBox's feature scope.
+
+    Please describe the environment in which you are running NetBox. Be sure
+    that you are running an unmodified instance of the latest stable release
+    before submitting a bug report.
+-->
+### Environment
+* Python version:  <!-- Example: 3.5.4 -->
+* NetBox version:  <!-- Example: 2.3.6 -->
+
+<!--
+    Describe in detail the new functionality you are proposing. Include any
+    specific changes to work flows, data models, or the user interface.
+-->
+### Proposed Functionality
+
+
+<!--
+    Convey an example use case for your proposed feature. Write from the
+    perspective of a NetBox user who would benefit from the proposed
+    functionality and describe how.
+--->
+### Use Case
+
+
+<!--
+    Note any changes to the database schema necessary to support the new
+    feature. For example, does the proposal require adding a new model or
+    field? (Not all new features require database changes.)
+--->
+### Database Changes
+
+
+<!--
+    List any new dependencies on external libraries or services that this new
+    feature would introduce. For example, does the proposal require the
+    installation of a new Python package? (Not all new features introduce new
+    dependencies.)
+-->
+### External Dependencies

+ 16 - 0
.github/ISSUE_TEMPLATE/housekeeping.md

@@ -0,0 +1,16 @@
+---
+name: :house: Housekeeping
+about: A change pertaining to the codebase itself
+---
+
+<!--
+    NOTE: This type of issue should be opened only by those reasonably familiar
+    with NetBox's code base and interested in contributing to its development.
+
+    Describe the proposed change(s) in detail.
+-->
+### Proposed Changes
+
+
+<!-- Provide justification for the proposed change(s). -->
+### Justification -->