Page MenuHomeHEPForge
Create Task
Maniphest T29

Define code formatting style and contributing policies for EvtGen
Open, NormalPublic
Actions

Description

Define a code formatting style for the EvtGen project.
Specifically, create a clang-format configuration file to define this.
Could also extend this to a set of guidelines for things that clang-format can't deal with, such as naming conventions etc.
All of this info could be included in a CONTRIBUTING.md file to define a procedure for those contributing code to the project.

Details

Commits
rEVTGEN1000e03ed667: Apply clang-format and fix compilation errors resulting from reordering of…
rEVTGENef6083cdd498: Small fix to clang-format to account for HepMC3 in ordering of includes
rEVTGENdcb6542d3c34: Tweak clang-format config and add script to apply to all files
rEVTGENfca002a8f162: Improve ordering/grouping of include files
rEVTGEN6dac58773e4a: Add clang-format config file

Related Objects

Event Timeline

tlatham created this task.May 20 2019, 5:28 PM
tlatham triaged this task as Normal priority.
tlatham created this object with edit policy "Restricted Project (Project)".
tlatham added a commit: rEVTGEN6dac58773e4a: Add clang-format config file.
tlatham moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Jul 5 2019, 9:11 PM
tlatham added a comment.Apr 27 2020, 6:23 PM

The clang-format part of this is essentially done.
The naming conventions etc. are still to be unified and written down.
Similarly, the rest of the CONTRIBUTING document needs to be written.

tlatham renamed this task from Define code formatting style for EvtGen to Define code formatting style and contributing policies for EvtGen.Jul 27 2020, 10:08 AM
tlatham changed the visibility from "All Users" to "Public (No Login Required)".
tlatham changed the edit policy from "Restricted Project (Project)" to "Restricted Project (Project)".Oct 6 2020, 10:18 AM