We need volunteer developers, such as you, to help make the Quantum Refinement project a massive success.
Here are some important resources:
- Website tells you all about us and our open source project,
- Source code is our repo for the entire project.
- Our tasks is our way of tracking important tasks.
- Mailing list: Join our developer list
- Bugs? Issue tracker is where to report them
- Slack:channel. We're usually there during business hours.
We have a few dozen unit tests, but most of them are rather slow. Please always add a test when you submit a pull request. Please try and make your tests run as quickly as possible.
Please send a GitHub Pull Request to qrefine with a clear list of what you've done (read more about pull requests). We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
We are trying to have readable code:
- We indent using two spaces.
- This is open source scientific software. Consider all of the people who will try and read your code.
- Please use the log object to keep track of what is happening in your code.
Thanks in advance, The Q|R team of core developers