Merge branch 'documentation' into 'develop'

Documentation

See merge request west-devel/West!15

AUTHORS.md

+This file lists the authors of the WEST code as well as the known contributors.
+
 # Project Leads 
 
 - Marco Govoni (Argonne National Laboratory and University of Chicago)
 - Giulia Galli (University of Chicago and Argonne National Laboratory)
 
-## Developers
+# Developers
+
+The current list of developers, in alphabetical order:
 
 - Sijia Dong (Argonne National Laboratory)
 - Marco Govoni (Argonne National Laboratory and University of Chicago)
 - He Ma (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)
-- 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)
+We would like to thank the following people for their contibution (beside generic comments and bugfixes), in alphabetical order:
 
-## 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
-- Matteo Gerosa 
-- Ryan McAvoy
-- Ngoc Linh Nguyen
-- Peter Scherpelz
-- Feng Wu 
-- Huihuo Zheng 
+Please, don't hesitate to contact us if you see that information is wrong or missing in this file.

CONTRIBUTING.md

+# 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
 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.
 
-# 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.
 Add demonstrations of new functionality, e.g. using Jupyter notebooks.
 
-# Testing
-
-Add tests for all new functionality.

README.md

@@ -13,5 +13,5 @@ See [CHANGELOG.md](CHANGELOG.md) for more information.
 ## Contributing 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
 
-## Contributors 
-See [CONTRIBUTORS.md](CONTRIBUTORS.md) for more information.
+## Authors
+See [AUTHORS.md](AUTHORS.md) for more information.