Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew McCluskey committed May 9, 2019
1 parent cfb61a2 commit 7fd2f51
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ If you want to find a good issue to get you in the door as a contributor, check

- We are trying to use a modular system within pylj, where there is the overarching `util` module that contains the `System` class which holds all system information. Examples of modules that use the `System` class are the `md` and `mc` module that facilite molecular dynamics and Monte-Carlo simulation respectively.
- All visuallisation should be done in the `sample` module, the structuring of this module should be clear and generally the only variable required should be the `System` class object.
- `pylj` uses [black]() formatted code, please run your changes through the black formatter before offering a pull request.
- If you want any help implementing your idea, please feel free to discuss it on our [gitter channel](https://gitter.im/pylj/Lobby#). We prefer this method of communication over email, however if you are morally or structurally aposed to gitter feel free to email [arm61](mailto:arm61@bath.ac.uk).
- If you would like to offer a pull request, we will try our best to assess and merge them as appropriate in a timely manner.

0 comments on commit 7fd2f51

Please sign in to comment.