Table of Contents
I Have a Question
-If you want to ask a question, we assume that you have read the available Documentation.
+If you want to ask a question, we assume that you have read the available Documentation.
-Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
-- Open an Issue.
+- Open an Issue.
- Provide as much context as you can about what you’re running into.
- Provide project and platform versions , depending on what seems relevant.
We will then take care of the issue as soon as possible.
@@ -81,8 +81,8 @@ Reporting BugsBefore Submitting a Bug Report
A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
-- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
@@ -97,7 +97,7 @@ How Do I Submit a Good Bug Report?You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to robert_baker@nps.gov.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
-- Open an Issue. (Since we can’t be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Open an Issue. (Since we can’t be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. See https://gist.github.com/hadley/270442 for a great run down on how to create reproducible examples.
- Provide the information you collected in the previous section.
@@ -113,14 +113,14 @@ Suggesting Enhancements
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 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.
+- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a search 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 or package.
- Please consult with the developers if you would like to create an add-on package. Maybe we can help!
If you want to ask a question, we assume that you have read the available Documentation.
+If you want to ask a question, we assume that you have read the available Documentation.
- Open an Issue.
- Provide as much context as you can about what you’re running into.
- Provide project and platform versions , depending on what seems relevant.
We will then take care of the issue as soon as possible.
@@ -81,8 +81,8 @@Reporting BugsBefore Submitting a Bug Report
A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version. -
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section). -
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker. +
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section). +
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback) @@ -97,7 +97,7 @@
- Open an Issue. (Since we can’t be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +
- Open an Issue. (Since we can’t be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. See https://gist.github.com/hadley/270442 for a great run down on how to create reproducible examples.
- Provide the information you collected in the previous section. @@ -113,14 +113,14 @@
- 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 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. +
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration. +
- Perform a search 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 or package.
- Please consult with the developers if you would like to create an add-on package. Maybe we can help!
How Do I Submit a Good Bug Report?You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to robert_baker@nps.gov.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
-Suggesting Enhancements
Before Submitting an Enhancement
How Do I Submit a Good Enhancement Suggestion?
-Enhancement suggestions are tracked as GitHub issues.
+Enhancement suggestions are tracked as GitHub issues.
- 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.
-
@@ -155,7 +155,7 @@
Attribution -
Developed by Robert Baker, Judd Patterson, Joe DeVivo, Issac Quevedo, Sarah Wright.
+Developed by Robert Baker, Judd Patterson, Issac Quevedo, Sarah Wright.