diff --git a/README.md b/README.md index 8e4c4ef..eeb4390 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # intro_python_chemists [![intro_python_chemists](https://circleci.com/gh/pythoninchemistry/intro_python_chemists.svg?style=svg)](https://circleci.com/gh/pythoninchemistry/intro_python_chemists) +[![DOI](https://zenodo.org/badge/248480226.svg)](https://zenodo.org/badge/latestdoi/248480226) + +This is an open-source project to develop an introductory textbook covering all aspects of Python programming for chemistry students (or all career positions). + +If you would like to be involved, please look at the [contributing guidelines](https://github.com/pythoninchemistry/intro_python_chemists/blob/master/content/contributing.md). + +## On coding style + +In this book we prioritise readibility and understandability of code over everything else. +Therefore, the code herein will **not** necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. +**All** issues opened that are based purely on standard adherence **will** be closed without considering. +However, we are open to issues and pull requests that discuss/improve coding style **if** the focus is on making the code clearer for the learner. \ No newline at end of file diff --git a/content/contributing.md b/content/contributing.md index d68ed61..abf8410 100755 --- a/content/contributing.md +++ b/content/contributing.md @@ -41,6 +41,13 @@ is difficult to describe as one unit of work, please consider splitting it into **Projects** are used to describe the broader picture of the `intro_python_chemists` project. More information about the overall project plan can be found on the Github [projects page](https://github.com/pythoninchemistry/intro_python_chemists/projects). +## On coding style + +In this book we prioritise readibility and understandability of code over everything else. +Therefore, the code herein will **not** necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. +**All** issues opened that are based purely on standard adherence **will** be closed without considering. +However, we are open to issues and pull requests that discuss/improve coding style **if** the focus is on making the code clearer for the learner. + ## Making a contribution The most likely place that you will contribute is in the [`content`](https://github.com/pythoninchemistry/intro_python_chemists/tree/master/content) of the book.