Process for contributing code to LArSoft¶
Process for contributing a non-architectural, non-breaking change to LArSoft:¶
- Become familiar with the design principles and coding guidelines of LArSoft.
- Develop the code including comments, tests and documentation.
- Offer it by talking about it to LArSoft team members and maybe give a presentation at the LArSoft Coordination Meeting.
Process for contributing an architectural, breaking change to LArSoft:¶
- Someone working on an experiment has an idea, an improvement, or a new feature that affects the LArSoft architecture that can be shared in the core LArSoft repositories.
- Developer contacts the LArSoft Technical Lead or other members of the core LArSoft team to discuss the idea. Discussion can include an email thread, formal meeting, chat in the hallway, phone call, or any communication that works.
- May find that the feature, or a suitable alternative, is already in LArSoft, thus saving the need to develop it again.
- At this point, a decision will be made as to whether further discussion or review is needed, and where that discussion should take place. If other experts are likely to be required, a plan for including them in the process will be developed. The division of labor for the architectural changes will be discussed as well.
- Developer learns/reviews the design principles and coding guidelines of LArSoft.
- Developer prepares a straw proposal or prototype for the change.
- For major changes as determined in step (2), the proposal should be presented at the biweekly LArSoft Coordination Meeting. Depending on the feedback, more than one presentation may be useful.
- The developer writes the code, including comments, tests, and examples as needed, and keeps the LArSoft team informed on the status of work.
- Any redmine pages or other technical documentation should be written during this time as well.
- For new algorithms and services, an entry in the list of algorithms should be made.
- When development is completed, request that it be merged onto the develop branch since this is a breaking change.
For more information, please read the LArSoft Note about Contributing Code.