Below is some guidance on how to report an OpenDCS bug or request a new feature.

GitHub  


  1. If you don't already have a GitHub account - create a GitHub account: https://github.com/ 
  2. Log into GitHub and navigate to the the OpenDCS repository: https://github.com/opendcs/opendcs
    1. If you aren't already, suggest 'Watching' the repository.  This is a feature in GitHub.  There are options to watch all activity or more limited activity.   
  3. Navigate to the issues tab at the top of the screen
  4. Create a new issue by clicking the green button on the right side of the screen 'New Issue'.  
    1. Select the appropriate type of issue from the options provided:
    2. For a Bug Report you will need to provide the following information
      1. Describe the bug
      2. To reproduce
      3. Expected behavior
      4. Screenshots
      5. Desktop/ServerSide
      6. Additional context
    3. For a Feature Request you will need to provide the following information 
      1. Is your feature request related to a problem? Please describe
      2. Describe the solution you'd like
      3. Describe alternatives you've considered
      4. Additional context
    4. For a Code Refactoring you will need to provide the following information
      1. Component to be refactored
      2. Purpose of refactoring
      3. Proposed method
      4. Additional context
    5. For a Report a security vulnerability you will need to provide the following information
      1. Summary
      2. Details
      3. PoC
      4. Impact
  5. Submit the Issue
  6. Make note of the issue number.
  7. Informational: What happens on GitHub after issue submitted: 
    1. The issue/bug will be reviewed by a project administrator
    2. Some labels may be applied or tagged (i.e. high/low priority)
    3. You can track if a bug or feature issue is being worked on by viewing the project page:  https://github.com/orgs/opendcs/projects/20 
      1. The issue will be in one of the following sections: No Status, Confirmed, Blocked, In Progress, Done
    4. If the issue is Done, then click on the issue. There should be some notes about what release contains (or will contain) the bug fix or new feature.  
    5. If the release is ready, there will be release notes that specify and reference the original issue.
  8. Check in from time to time and see the status.  You can comment on your submitted issues and ask for an update on the issue.

The next steps are recommended to help disseminate and share information with other USACE CWMS users.

Discourse

  1. If you don't already have a Discourse account, create one: https://discourse.hecdev.net/ 
  2. Navigate to the appropriate Category (OpenDCS)
  3. Create a New Topic. 
    1. Summarize the issue and post a link to the GitHub issue.  This is helpful in case other users are also experiencing the same issue. 
      1. If this is the case the other user is encouraged to comment and share this information.  This will help prioritize the issue. 
      2. If another user has a work-around (for while the issue is being worked on), the user is encouraged to share this information.

E-mail CWMS-OpenDCS-Support@usace.army.mil

  1. Some users have a need to notify and inform other folks in their offices (i.e. supervisors, or coworkers, etc).  When this is the case, e-mail CWMS-OpenDCS-Support@usace.army.mil cc the necessary colleagues.  
    1. Summarize the issues and include a link to the issue and/or topic.