Skip to content

Commit fa944ee

Browse files
georgeRobertsongeorgeRobertson
authored
Merge branch 'master' into coding_style_guide
2 parents 4ee52cf + 285836a commit fa944ee

4 files changed

Lines changed: 23 additions & 7 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
* **Please check if the Pull Request fulfills these requirements**
2+
- [ ] The commit message is clear and concise
3+
- [ ] Test for the changes have been added and reviewed
4+
- [ ] Documentation has been added to all new features and edited code has had documentation reviewed
5+
6+
* **What kind of change does this Pull request introduce?** (Bug fix, feature, docs update, ...)
7+
8+
* **What is the current behaviour?** (Link to a current open issue if possible)
9+
10+
* **What is the new behaviour?** (is this a feature change?)
11+
12+
* **Does this Pull Request introduce a breaking change?** (What changes might users need to make in their application due to this PR?)

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,8 @@ First off, thank you for taking the time to contribute! If you have a functional
1212

1313
We suggest you make sure all of your commits are atomic (one feature per commit). Please make sure that non-obvious lines of code are commented, and variable names are as clear as possible. Please do not send us undocumented code as we will not accept it. Including tests to your pull request will bring tears of joy to our eyes, and will also probably result in a faster merge.
1414

15-
1615
## Coding conventions
1716

18-
1917
We use the industry standard [PEP 8](https://www.python.org/dev/peps/pep-0008/) styling guide within the `codonPython` package. **Therefore, it’s imperative that you use the coding standards found within PEP 8 when creating or modifying any code within the `codonPython` package**. Autoformatters for PEP8, for instance [autopep8](https://pypi.org/project/autopep8/), can easily ensure compliance. The reason we use PEP 8 coding standards is to make sure there is a layer of consistency across our codebase. This reduces the number of decisions that you need to make when styling your code, and also makes code easier to read when switching between functions etc.
2018

2119
While you are creating code, we recommend that you understand the style guide standards for the following topics:
@@ -32,5 +30,13 @@ We also use docstrings and we try to follow [`numpy`'s docstring standards](http
3230

3331
Start reading our code to get a feel for it but most importantly, remember that this is open source software - consider the people who will read your code, and make it look nice for them.
3432

33+
* We use [PEP8](https://www.python.org/dev/peps/pep-0008/). Autoformatters for PEP8, for instance [autopep8](https://pypi.org/project/autopep8/), can easily ensure compliance.
34+
* We use docstrings and we try to (loosely) follow [`numpy`'s docstring standards](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard).
35+
* This is open source software. Consider the people who will read your code, and make it look nice for them.
36+
37+
## Code of Conduct
38+
39+
As a contributer you can help us keep the Codon community open and inclusive. Please read and follow our [Code of Conduct](https://github.com/codonlibrary/code-of-conduct/tree/master). By contributing to it, you agree to comply with it.
40+
3541
:clinking_glasses: Thank you!
36-
Team codon
42+
Team codon

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,4 @@ Quick links to begginer guidance can also be found below:
4545

4646
All other `codon` "How-to Articles" can be found [here.](https://github.com/codonlibrary/codonPython/wiki/2.-Git-Guidance)
4747

48-
Suggestions regarding additional guidance or How-to articles are welcome.
49-
50-
48+
Suggestions regarding additional guidance or How-to articles are welcome.

‎codonPython/check_null.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import numpy
22
import pandas as pd
33

4-
def check_null(dataframe: pd.DataFrame, columns_to_be_checked: list) -> bool:
4+
def check_null(dataframe: pd.DataFrame, columns_to_be_checked: list) -> int:
55
"""
66
Checks a pandas dataframe for null values
77

0 commit comments

Comments
 (0)