Developer’s Guide

Submitting a bug report

In case you have encountered an issue with BaseITS, please submit it to the BaseITS issue tracker on GitHub. Where possible, please include a screenshot of the output generated by BaseITS.

Submitting a feature request

If you are suggesting a new feature, please submit it to the BaseITS issue tracker on GitHub. Please describe the proposed feature in detail including what it does, the parameters it takes and the output it generates. You can also discuss it on the BaseITS-Help Slack channel.

Contributing code

The preferred way of contributing to BaseITS is to fork the main BaseITS repository on Github, then submit a pull request after committing changes make to the fork repository.

1. Create an account on Github.

2. Fork the main BaseITS repository by clicking the ‘Fork’ button at the top right of the BaseITS gitHub interface. Forking creates a copy of the code under your Github account.

3. Clone the forked repository to your local machine. Note that you can clone the repo using SSH or HTTPS.

   $ git clone git+ssh://git@github.com/IBM/ITS-analysis-for-model-driven-inference.git
   

   $ git clone git+https://token@github.com/IBM/ITS-analysis-for-model-driven-inference.git
   

   $ git clone install https://github.ibm.com/USERNAME/ITS-analysis-for-model-driven-inference.git
   

4. Create a branch to track your changes:

   $ git checkout -b issue-101
   

5. Write your code along with the documentation and unit tests that show that a feature works as expected or a bug as fixed. Use Git for version control by adding modified files and commiting changes:

   $ git add modified_files
   $ git commit -m 'Closes #1101: added doc strings to utils.py'
   

6. Push changes to Github

   $ git push -u origin issue-101
   

7. Submit a pull request from your branch to the respective branch and wait for review.

Getting Dev Help

For any questions or assistance please send your message to the BaseITS-Help Slack channel.