Skip to content

Commit 285836a

Browse files
georgeRobertsonmurd0
georgeRobertson
authored and
murd0
committed
Code of conduct (#103)
* Added template code of conduct to CONTRIBUTING.md * fixed formatting on CONTRIBUTING.md * restructured CONTRIBUTING.md * fixed code of conduct template on CONTRIBUTING.md * update code of conduct link in CONTRIBUTING.md * added PULL_REQUEST_TEMPLATE.md to .github * fixed markdown within pull_request_template.md * Fixed typo in README.md and added content to CONTRIBUTING.md
1 parent 8bbb97f commit 285836a

3 files changed

Lines changed: 19 additions & 3 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: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Start reading our code to get a feel for it:
2020
* 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.
2121
* We use docstrings and we try to (loosely) follow [`numpy`'s docstring standards](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard).
2222
* This is open source software. Consider the people who will read your code, and make it look nice for them.
23-
23+
24+
## Code of Conduct
25+
26+
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.
27+
2428
:clinking_glasses: Thank you!
25-
Team codon
29+
Team codon

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## What is `codon`?
77

8-
The `codon` project was created to increase code sharing, consistancy of code and coding standards and encourage collaboration. The repository contains Python, R and SQL code for ease of use in workflows on platforms used within NHS Digital such as Databricks. Everything you need to use the repository should be available on the GitHub pages however further information for NHS Digital staff can be foun [here](https://confluence.digital.nhs.uk/display/CON/Codon+-+Code+sharing), via our internal confluence page. `codonPython` aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability.
8+
The `codon` project was created to increase code sharing, consistancy of code and coding standards and encourage collaboration. The repository contains Python, R and SQL code for ease of use in workflows on platforms used within NHS Digital such as Databricks. Everything you need to use the repository should be available on the GitHub pages however further information for NHS Digital staff can be found [here](https://confluence.digital.nhs.uk/display/CON/Codon+-+Code+sharing), via our internal confluence page. `codonPython` aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability.
99

1010
### Why `codon`?
1111

0 commit comments

Comments
 (0)