Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.87 KB

Contributing.md

File metadata and controls

31 lines (18 loc) · 1.87 KB
Raw

Contributing to TIMES

Contribution to TIMES is currently done through "Issues" in GitHub which can be used for:

  1. filing bug reports, and
  2. submitting feature and enhancement requests,

and discussing all the necessary details about them.

In "Issues", you can insert code snippets, links and attachments that demonstrate the issue or describe the proposed enhancement in detail. When a consensus is reached about an issue, the maintainer of TIMES will proceed by implementing the fix or the new feature, and integrate it in the next release of the ETSAP TIMES code.

Currently the TIMES code is maintained by @Antti-L.

This is the current approach of managing contributions to TIMES, without the need for "pull requests" for the Master branch. For eventual bigger projects a different workflow may be useful in separate branches.

Resources:

  • The main ETSAPwebsite is a good place to get started with TIMES.
  • Extended documentation for TIMES is available on the website.
  • The forum is the main place to ask questions and search for answers from the ETSAP community.

Bugs

If you find a programming error in TIMES, please submit an Issue in the repository. Follow the issue template for submitting a bug.

Errors in the documentation

The documentation can be found in the Documentation Repository. Please report issues with the Documentation here.

Ideas and Suggestions

If you have an idea on how TIMES could be improved, or to suggest useful additions, please submit a request using the Github issue here.