search

aiidateam / aiida-quantumespresso

The official AiiDA plugin for Quantum ESPRESSO
https://aiida-quantumespresso.readthedocs.io
Other
53 stars 78 forks source link

Add test info to README #889

Closed superstar54 closed 1 year ago

superstar54 commented 1 year ago

Add a development section with test info into the README. This will be helpful for the new developer.

sphuber commented 1 year ago

I'm ok with adding these to the README, but maybe the documentation or wiki might be a better place? @sphuber what do you think?

I think for now the README is fine. If I visit other projects myself to develop, the first place I look is the README of the repo. I think the wiki is not an intuitive first place to look. I know we use it for AiiDA for certain things, but that is another story. So for me it is fine to add this now.

@superstar54 Maybe we can also add the following section

### Pre-commit
To contribute to this repository, please enable pre-commit so the code in commits are conform to the standards.
Simply install the repository with the `pre-commit` extra dependencies:
```shell
cd aiida-quantumespresso
pip install -e .[pre-commit]
pre-commit install
mbercx commented 1 year ago

@superstar54 and while you're at it, maybe fix the typo in the Acknowle_d_gements header :D

superstar54 commented 1 year ago

@mbercx Thanks for the suggestions. Thanks @sphuber, pre-commit section is also added.