ESyS-Particle

Testing and merging policy

Asked by Łukasz Łaniewski-Wołłk

I have two questions related to development of the code:

Is there any test suit that could be used while editing the code to test if nothing was broken (and also test performance)?

What is the policy on merging with the code in the trunk?

Question information

Language:
English Edit question
Status:
Answered
For:
ESyS-Particle Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Dion Weatherley (d-weatherley) said : 		#1

Hi Lukasz,

Thanks for the questions.

> Is there any test suit [...]?

Currently ESyS-Particle does not have a comprehensive suite of test cases. Typically we test the code-base by running the simulations contained in the Tutorial. If these run correctly, then "most" features of ESyS-P should be functioning properly.

We are presently discussing compilation of a more comprehensive suite of QA simulations/tests. If you would like to contribute ideas or volunteer to help with this, please contact me via direct email.

> What is the policy on merging with the code in the trunk?

The ESyS-Particle developers welcome and encourage code contributions from other users/developers. Our preferred method to evaluate and incorporate code contributions is via launchpad's merge request facilities. This is most easily done by branching the latest esys-particle/trunk development version, to another bzr repository maintained on launchpad. Having committed your changes to this branch, request for this to be merged with the trunk. The ESyS-Particle developers will then review the branch and decide on whether/how to merge this into the main development tree.

For code contributions representing a significant intellectual contribution (e.g. adding a major new feature) our preference is for developers to extensively test their own implementation prior to requesting a merge. It is also highly advantageous to publish a peer-reviewed journal article describing the methodology and results of validation exercises, prior to merging with the trunk. The ESyS-Particle developers will make every effort to ensure that this publication is cited whenever the new feature is used by others.

Remember to add your own copyright header (including the current Apache License information) to any *new* files added to the ESyS-Particle trunk. You may also (optionally) add a comment to any existing files, detailing changes made by you; if such changes are more than just minor additions for interfacing classes/APIs etc.

Cheers,

Dion

Can you help with this problem?

Provide an answer of your own, or ask Łukasz Łaniewski-Wołłk for more information if necessary.

To post a message you must log in.