Ctrl+K

Contributing

Contributing#

We welcome contributions to the book and the model. In each case credit will be given. Please do not feel you need to be an expert to contribute all views and feedback are greatly appreciated. You can contribute in the following ways:

Typographical and grammatical errors#

If you spot a typo, spelling mistake, poor grammar (no matter how minor), or just feel a sentence/paragraph could be rewritten to improve clarity, we would greatly appreciate you reporting it. You can do that by raising a Github issue via the repository. The url is TomMonks/treatment-centre-sim#issues

When you submit an issue please provide:

  • link to page of book with the error

  • Original sentence(s) that contain the error.

  • Suggested fix

  • Label the problem as documentation.

Reporting bugs#

If you find a bug in any of the code please report via Github issues. Please provide the following:

  • The operating system and version you are using.

  • Details of your python dependencies or virtual environment if you are using one. (if using conda please provide a environment.yml file - see the conda exercises for help )

  • Steps to reproduce the problem including the url.

  • Please label the problem as bug

  • Optional: recommended fix.

Note: Before reporting a bug please check that the Jupyter notebook cells have been been run in order. We recommend selecting ‘Reset Kernel and Clear All Outputs’ from the Kernel menu and rerunning the notebook to confirm.

Submit general feedback or request new content#

The book will evolve over time. We would greatly welcome feedback, via Github issues, on the book including requests for new new topics, chapters, or expanded sections.

Requests#

For new content requests please

  • Detail the requested content.

  • Provide a case why this content relevant to this study.

  • Optional: provide an example

  • Label the issue an an enhancement

General feedback#

For anything I’ve not covered here please submit a Github issue labelled as feedback

Code of conduct#

If you wish to contribute in any of the above ways, including responding to feedback from others, then I ask you to follow the contribution code of conduct for this book.

  • Demonstrating empathy and kindness toward other people

  • Being respectful of differing opinions, viewpoints, and experiences

  • Giving and gracefully accepting constructive feedback

  • Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience

  • Focusing on what is best not just for us as individuals, but for the overall community

These guidelines are adapted from the Contributor Covenant

Contents