Update contributing guide

[tovrstra]

This is another step in #313.

I've revised the document to be up-to-date with the recent changes listed in #313 and tried to improve the readability.

Some points were taken from the central contributing guide and updated. Eventually, most of it can be centralized (the first four sections). There is also a difference in scope: this document is a bit more tutorial-like than the central one.

Direct link to the new version (easier to read than the diff): https://github.com/tovrstra/iodata/blob/1032c13485a2dba0f8298617028145d806d5dc1d/CONTRIBUTING.rst

Summary by Sourcery

This pull request updates the contributing guide to reflect recent changes and improve readability. It also updates pre-commit hooks to newer versions and removes an unnecessary noqa comment in the code.

• Enhancements:
  • Updated pre-commit hooks to newer versions in .pre-commit-config.yaml.
• Documentation:
  • Revised the contributing guide to be up-to-date with recent changes and improved readability.
• Chores:
  • Removed unnecessary noqa comment in iodata/utils.py.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the contributing guide to align with recent changes and improve readability. It also includes minor updates to the pre-commit configuration and a small code cleanup in the iodata/utils.py file.

File-Level Changes

Files	Changes
.pre-commit-config.yaml	Updated versions of pre-commit hooks to ensure compatibility and leverage new features or fixes.
iodata/utils.py	Cleaned up code by removing an unnecessary noqa comment.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[deepsource-io]

Here's the code health analysis summary for commits 2774afc..1032c13. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Shell	✅ Success		View Check ↗
Python	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[sourcery-ai]

Hey @tovrstra - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[PaulWAyers]

It looks good. I created an issue in theochem/Guidelines so we don't lose track of the need to harmonize this across repositories (though the last part of this document is specific to IOData.

[tovrstra]

@PaulWAyers Thanks for reviewing.

Good point. I'll write out the whole CI setup of IOData in an imminent pull request. For now, the main missing piece for IOData is coverage analysis. It is not so hard to get to work, but it makes testing so slow.

More general versions of this and the next PR are certainly desirable. When working these out, it would be good to get an idea of what everyone else's perspective on the matter is. For a given selection of tools, I can cook up the most recent way to use them, but which tools to use remains (somewhat) a matter of taste. There are a few different tools one can use for each CI task, and they all have their strengths. A bit of diversity is actually also useful to gather more experience.