A contributing guide to QUANTICS

Quantics development
1

I was wondering if we could have a brief “How to contribute to Quantics” guide for people who are new to the project. It could be just a simple text file in the repo (on Github, a typical open source project has a file called CONTRIBUTING.md)

Some of the things that could be discussed there:

  1. How to setup your development environment
  2. Code formatting and code style
  3. How to submit a patch (basics of Merge requests on Gitlab).
  4. What is the review process like?
  5. How to test new functionality, how to write automated tests

Basically I think submitting contributions to such an established project can be quite intimidating so a bit of encouragement might be nice. :slight_smile:

As an example, here’s a contributing guide that I have for ABIN:

CC @gaworth does that make sense?
(the other purpose of this topic is to kickstart the Quantics development category :blush: )

1 Like
2

Ah, I see there is this page:

https://www2.chem.ucl.ac.uk/worthgrp/quantics/doc/code/guidelines.html

So I guess just making sure it is up to date, and perhaps link to it from the main README in the repo? (or link to the new documentation in progress?)

3

It would be great to have the contributing guidelines updated for the upcoming hackathon. :slight_smile:

Also for the hackathon and in general, it would be great to have a set of issues suitable for first-time contributors to the programs (on open source repositories on GitHub such issues are often labeled as “good first issue”).

I would imagine these could be small bugs, or small features, and would be documented as issues on GitLab https://gitlab.com/quantics/quantics/-/issues (perhaps with a bit more pointers than usual e.g. pointing to which part of the code should one look to implement the given feature or bugfix).

@gaworth @eryn.spinlove Let me know what you think, or if you’ve already had some ideas.

4

HI Daniel,
Agreed. I’ll try and set some issues + guidelines before the end of the week
Graham

2 Likes