Galore is managed by the Scanlon Materials Theory group at University College London, and is open to contributions from third parties. If you have an idea to make Galore better, please open an Issue outlining your idea on the Github issue tracker. This will allow a public discussion of how well this fits the project design and goals, and how it might be implemented.

Making changes

All contributions from third parties are managed using “Pull requests” on Github, as are major changes by the core developers. Create a copy of the project on your own Github account using the “Fork” button near the top-right of the web interface and make your changes on a new branch based on master. When you are ready to share these changes, create a pull request; this will open a public discussion here.

Before making substantial changes, please begin discussion in an Issue so you have some idea if your proposal is likely to be accepted! For minor corrections it may be easier to move straight to a pull request.

Galore is licensed under GPLv3 (see LICENSE file), including any third-party contributions.

Coding guidelines

  • Please follow PEP8 including the 79-character line width limit. You can run a style checker on your code when you are done; a decent one called pep8 can be obtained with pip install pep8.

  • It is helpful to start commit messages with a short code indicating the type of change made; this makes it easier to scan the list of commits looking for e.g. documentation changes. The codes are loosely borrowed from this scheme used by the ASE project, but no strict scheme is enforced.

  • Please ensure your changes pass the test suite (python3 test) and consider adding tests for any new behaviour. It can be helpful to write the test before you finish implementing the feature.