Updating the code

We would like users to help us in adding features to the code. However, since we have limited time and resources to put into assisting users and reviewing their codes, our default position is that the code is locked to non members of the collaboration, and unsolicited requests to add major features will usually be declined. This is in order to maintain the quality of the code.

If you have developed a feature that you would like to share with other users, the steps to follow are:

• develop the feature in your own fork, paying attention to our coding conventions
• Contact us to discuss adding it, or submit an issue to the issues log describing the feature
• You should include details of tests you have done which confirm that the code works as expected, and preferably cite a peer reviewed publication in which it was used
• Once we have agreed in principle that the feature should be included, we will give you access to create a new branch and put a clean version into it
• You can then submit Pull requests to the main branch, which will be reviewed by members of the collaboration

Note that running:

make all

In the GRChombo directory will make and run all the tests and compile the examples. This is a good check that any coding you have done has not broken other features. These tests run automatically on submission of a pull request, but should be checked prior to submission.