Skip to content

Commit

Permalink
Merge pull request #3 from arm61/arm61-contributing-1
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
Andrew McCluskey authored Jun 9, 2018
2 parents e5e5e5b + 94fb8b9 commit a16af9a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Contributing

If you are interested in contributing to pylj. Please feel free; fork the code and go wild to your hearts content.

#### Notes

- 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.
- If you want any help implementing your idea, please feel free to discuss it on our [Slack channel](https://pylj.slack.com). We prefer this method of communication over email, however if you are morally or structurally aposed to Slack feel free to email [arm61](mailto:[email protected]).
- If you would like to offer pull requests we will try our best to assess and merge them as appropriate in a timely manner.

0 comments on commit a16af9a

Please sign in to comment.