Commit f4ec050b authored by Marco Govoni's avatar Marco Govoni
Browse files

Merge branch 'documentation' into 'develop'

Documentation

See merge request west-devel/West!15
parents 38d2fa03 030666cb
This file lists the authors of the WEST code as well as the known contributors.
# Project Leads # Project Leads
- Marco Govoni (Argonne National Laboratory and University of Chicago) - Marco Govoni (Argonne National Laboratory and University of Chicago)
- Giulia Galli (University of Chicago and Argonne National Laboratory) - Giulia Galli (University of Chicago and Argonne National Laboratory)
## Developers # Developers
The current list of developers, in alphabetical order:
- Sijia Dong (Argonne National Laboratory) - Sijia Dong (Argonne National Laboratory)
- Marco Govoni (Argonne National Laboratory and University of Chicago) - Marco Govoni (Argonne National Laboratory and University of Chicago)
- He Ma (University of Chicago) - He Ma (University of Chicago)
- Han Yang (University of Chicago) - Han Yang (University of Chicago)
## Contributors # Former Developers
The former list of developers, in alphabetical order:
- Nicholas Brawand (2016-2018)
- Matteo Gerosa (2017-2018)
- Ryan McAvoy (2017-2018)
- Ngoc Linh Nguyen (2017-2018)
- Peter Scherpelz (2016-2017)
- Huihuo Zheng (2016-2018)
# Contributors
- Francois Gygi (University of California, Davis) We would like to thank the following people for their contibution (beside generic comments and bugfixes), in alphabetical order:
- Ikutaro Hamada (Osaka University)
- Yuan Ping (University of California, Santa Cruz)
- Jonathan Skone (University of Chicago)
- Tyler Smart (University of California, Santa Cruz)
- Aditya Tanikanti (University of Chicago)
## Former Developers - Francois Gygi (University of California, Davis): for strategic discussions
- Ikutaro Hamada (Osaka University): for the first implementation of k-points
- Yuan Ping (University of California, Santa Cruz): for the first implementation of 2D cutoff
- Jonathan Skone (University of Chicago): hybrid functionals
- Tyler Smart (University of California, Santa Cruz): for the first implementation of 2D cutoff
- Aditya Tanikanti (University of Chicago): for improving deployment and testing
- Feng Wu (University of California, Santa Cruz): for the first implementation of 2D cutoff
- Nicholas Brawand Please, don't hesitate to contact us if you see that information is wrong or missing in this file.
- Matteo Gerosa
- Ryan McAvoy
- Ngoc Linh Nguyen
- Peter Scherpelz
- Feng Wu
- Huihuo Zheng
# Contributing to the source
Contributions are welcomed via merge requests. Contact the **WEST** developers before starting work to ensure it meshes well with the planned development direction and Contributions are welcomed via merge requests. Contact the **WEST** developers before starting work to ensure it meshes well with the planned development direction and
standards set for the project. standards set for the project.
# Features ## Version control
All changes in a pull request should be closely related. Multiple change sets that are loosely coupled should be proposed in separate pull requests. Use a consistent style for writing code.
## Features
New features should be applicable to a variety of use-cases. The **WEST** developers can assist you in designing flexible interfaces. New features should be applicable to a variety of use-cases. The **WEST** developers can assist you in designing flexible interfaces.
# Version control ## Testing
All changes in a pull request should be closely related. Multiple change sets that are loosely coupled should be proposed in separate pull requests. Use a consistent style for writing code. Add tests for all new functionality.
# Documentation ## Release
We use [semantic versioning](https://semver.org/), i.e. version labels have the form v`<major>`.`<minor>`.`<patch>`
- Patch release: v0.0.0 to v0.0.1, only bug fixes
- Minor release: v0.0.0 to v0.1.0, bug fixes and new features that maintain backwards compatibility
- Major release: v0.0.0 to v1.0.0, bug fixes and new features that break backwards compatibility
# Contributing to the documentation
Comment complex sections of code so that other developers can understand them. Comment complex sections of code so that other developers can understand them.
Add demonstrations of new functionality, e.g. using Jupyter notebooks. Add demonstrations of new functionality, e.g. using Jupyter notebooks.
# Testing
Add tests for all new functionality.
...@@ -13,5 +13,5 @@ See [CHANGELOG.md](CHANGELOG.md) for more information. ...@@ -13,5 +13,5 @@ See [CHANGELOG.md](CHANGELOG.md) for more information.
## Contributing ## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
## Contributors ## Authors
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for more information. See [AUTHORS.md](AUTHORS.md) for more information.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment