From 3b44248da631b6c12bf533b5941301c130218104 Mon Sep 17 00:00:00 2001 From: Alex Pearce Date: Mon, 17 Jun 2019 13:15:24 +0000 Subject: [PATCH 1/2] Create README and CONTRIBUTING files. --- CONTRIBUTING.md | 14 ++++++++++++++ README.md | 11 +++++++++++ 2 files changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..6b66b67406 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing to Moore + +Contributions to Moore are accepted in the form of merge requests. Code should +conform to the C++ and Python formatting standards define by the CI. The +checker will run automatically when you push new commits to your branch, and +will generate a patch you can apply if the checks fail. + +## Branches + +The `master` branch is used for Run 3 development and data-taking. This is the +usual branch to open merge requests against. + +Some other branches track code from previous campaigns. Open an issue if you're +unsure what branch to use. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..4f6f2d40d8 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Moore + +Moore is the application for the LHCb high level trigger (HLT). This repository +contains the application configuration code, including the definition of the +HLT1 and HLT2 reconstruction and physics selections (lines). Reconstruction- +and selection-specific algorithms are mostly defined in the +[Rec](https://gitlab.cern.ch/lhcb/Rec) and +[Phys](https://gitlab.cern.ch/lhcb/Phys) projects. + +Information on contributing to Moore is given in the [CONTRIBUTING +file](CONTRIBUTING.md). -- GitLab From aa45fed826604af600ded77966343bace8b31425 Mon Sep 17 00:00:00 2001 From: Rosen Matev Date: Thu, 20 Jun 2019 17:45:11 +0200 Subject: [PATCH 2/2] Add format and lint instructions --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b66b67406..15f10fa1be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,15 @@ conform to the C++ and Python formatting standards define by the CI. The checker will run automatically when you push new commits to your branch, and will generate a patch you can apply if the checks fail. +To simplify the workflow, you can format and lint locally using + +```shell +lb-format path/to/file +flake8 path/to/file +``` + +Check [Git4LHCb](https://twiki.cern.ch/twiki/bin/view/LHCb/Git4LHCb) for more details. + ## Branches The `master` branch is used for Run 3 development and data-taking. This is the -- GitLab