Skip to content

Add a mention of style and where our focus is #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bjmorgan merged 2 commits into from
Mar 23, 2020
Merged

Add a mention of style and where our focus is #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8af61c9
add a brief discussion of coding style
Mar 23, 2020
39a828e
remove style from intro
Mar 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions content/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down