Skip to content

Commit 64d23bc

Browse files
authored
Update to Contibution Guid
"What is codon looking for" title added to the read me for quick and obvious guidance to user on the type of code codon wants. CON-43
1 parent 361e646 commit 64d23bc

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,22 @@ python -m pip install --user git+https://github.com/codonlibrary/codonPython.git
2929
```
3030
For further guidance on cloning from the remote repository to a local repository on your machine see the information in our [Wiki.](https://github.com/codonlibrary/codonPython/wiki/1.-Installing-codonPython)
3131

32-
## Contributing to codonPython
33-
All new contributions to `codon` are welcome; please follow the Coding Conventions in the [guidance document](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance.
32+
## What is Codon looking for?
33+
Codon is looking for any **fully parametrised functions** that are useful in data publication work flows. Any other parametrised functions useful for healthcare Data, Insights or Statistics (DIS) are also welcomed.
34+
35+
Please check the `Codon` Do's and Don’ts against your code before contributing;
36+
37+
| Do's | Don'ts |
38+
|------|---------------|
39+
| Contribute fully parametrised code. |Supply non-parameterised scripts |
40+
|Supply unit and expected error testing files at 100% coverage| Untested functions|
41+
|Include function doc strings| Contribute code from established libraries. i.e. Pandas, NumPy, Matplotlib.|
42+
|Follow [PEP-8](https://www.python.org/dev/peps/pep-0008/) styling guide. |Be afraid to [ask](email) for any further guidance.|
43+
44+
45+
*Testing files should always cover 100% of the contributed code. If this is not achievable please highlight this during the Pull-Request process to the Codon team.*
46+
47+
Please follow the [guidance document](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for further detailed guidance on contribution and Coding Convention.
3448

3549
Any improvements to documentation, bug fixes or general code enhancements are also welcomed. If a bug is found on the master branch, please use the GitHub guidance on raising an [issue.](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue)
3650

0 commit comments

Comments
 (0)