-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from arm61/arm61-contributing-1
Create CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
10 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |