-
Notifications
You must be signed in to change notification settings - Fork 64
How to ask a question, report a bug, or ask for a new feature
All development, whether for a new feature, bug fix, re-engineering task, or documentation or data update, MUST begin with opening an issue. An open issue allows for transparency, developer and community input, assignment of the task, and progress tracking.
An issue should always have at least one these labels: bug, documentation, enhancement, question, or help wanted. These issue types are discussed below.
- Report a Bug
- Improve or Correct Documentation
- Suggest a New or Improved Feature
- Ask a Question
- Ask For Help
The title of a bug-fix issue should be a succinct (< 70 character) summary of the problem. The text of a bug fix issue should clearly describe the following:
Summary of Issue:
- Expected behavior and actual behavior
- Steps to reproduce the problem (should include any required input file(s) or link to public repository)
- The CCPP-Framework changeset ID of the code and the machine you are using
- Has the code been modified relative to the changeset? If so, it must be committed and available for testing:
- Screen output or log file showing the error message and context
A template will be provided to aid in the process.
Open an issue of this type if you plan to work on the documentation or if you notice something incorrect or missing. While much of the content of the bug-report template is not relevant here, please do include the CCPP-Framework changeset ID along with a description of the work that needs to be done and the location (or proposed location(s)) in the documentation.
To request a new feature or ask for an improvement to an existing feature, please fill in the following items (some are already in the template):
- Expected behavior (what is the effect of the new feature?)
- When will the new feature be used (i.e. use cases)?
- What user interface changes or additions will be required?
- What is the CCPP-Framework changeset ID of the code you are currently using?
This type of issue is relatively free form but be sure to include a simple phrasing (<70 characters) of the question in the subject. Be sure to describe the use case, the issues you are having, and the CCPP-Framework changeset ID of the code you are currently using.
This label is reserved for CCPP-Framework developers who need help with a task.