Skip to content

Commit f23b652

Browse files
authored
Merge pull request #32 from arm61/style
Add a mention of style and where our focus is
2 parents 0266770 + 39a828e commit f23b652

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
# intro_python_chemists
22

33
[![intro_python_chemists](https://circleci.com/gh/pythoninchemistry/intro_python_chemists.svg?style=svg)](https://circleci.com/gh/pythoninchemistry/intro_python_chemists)
4+
[![DOI](https://zenodo.org/badge/248480226.svg)](https://zenodo.org/badge/latestdoi/248480226)
5+
6+
This is an open-source project to develop an introductory textbook covering all aspects of Python programming for chemistry students (or all career positions).
7+
8+
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).
9+
10+
## On coding style
11+
12+
In this book we prioritise readibility and understandability of code over everything else.
13+
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.
14+
**All** issues opened that are based purely on standard adherence **will** be closed without considering.
15+
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.

content/contributing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ is difficult to describe as one unit of work, please consider splitting it into
4141
**Projects** are used to describe the broader picture of the `intro_python_chemists` project.
4242
More information about the overall project plan can be found on the Github [projects page](https://github.com/pythoninchemistry/intro_python_chemists/projects).
4343

44+
## On coding style
45+
46+
In this book we prioritise readibility and understandability of code over everything else.
47+
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.
48+
**All** issues opened that are based purely on standard adherence **will** be closed without considering.
49+
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.
50+
4451
## Making a contribution
4552

4653
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.

0 commit comments

Comments
 (0)