Commit e833afd2 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Fix some last things in readmes

parent 811b24d3
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ SPDX-License-Identifier: CC-BY-4.0

(Please provide the logging output of your simulation with one single event and the logging level set to `DEBUG`. If your issue only concerns one single module, consider switching the logging level only for the module in question.)

(Please use code blocks (```) to format console output, logs, and code as it's very hard to read otherwise.)
(Please use code blocks (```) to format console output, logs, and code as it is hard to read otherwise.)

#### Build environment information

+36 −36
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ Thanks for considering to contribute to Allpix Squared. Any type of merge reques
to the documentation to entirely new functionality, is much appreciated. We, the maintainers, will try to our best to look
carefully at every merge request.

If you only want to submit an issue, that is also very welcome, please continue directly to the issue tracker
If you only want to submit an issue, that is also welcome, please continue directly to the issue tracker
\[[@ap2-issue-tracker]\] to open a ticket.

The following is a set of guidelines that will help both you as submitter as well as us maintainers to make it as easy as
@@ -24,7 +24,7 @@ individual merge request. Also try to submit individual merge request for indepe
separately.

If you have any doubt about the best way to implement new functionality or how to split it up, please open an issue with the
discussion tag on the issue tracker \[[@ap2-issue-tracker]\]. Also please feel free to open a incomplete merge request as
discussion tag on the issue tracker \[[@ap2-issue-tracker]\]. Also please do open a incomplete merge request as
soon as possible with the "Draft" label to allow for early discussion.

## Getting started
@@ -75,16 +75,16 @@ is not a problem to open a merge request for incomplete implementations.
6. Add all the specific runners on your local repository at
   https://gitlab.cern.ch/your-username/allpix-squared/settings/ci_cd.
7. The pipeline can now be restarted and the CI will check your changes. If the CI fails and gives an error please refer to
    the log containing a description about what went wrong. It is very likely that errors will appear because Allpix Squared
    enforces a very strict policy of compiler errors and requires full compliance of the clang-tidy "linter" tool, which
   the log containing a description about what went wrong. It is likely that errors will appear because Allpix Squared
   enforces a strict policy of compiler errors and requires full compliance of the clang-tidy "linter" tool, which
   frequently complains about minor changes (it might help to search for `error:` to find the actual error(s) in the
   output). This clang-tidy tool can also be run locally on your pc by executing `make check-lint` from the build directory.
   Easy changes can be fixed automatically by executing `make lint`.
8. The maintainers will look at your proposed changes and likely provide some (constructive) feedback.
9. Please continue to update the code with the received comments until every reviewer and the continuous integration is
   happy :)
10. Your merge request can now be merged in. Congratulations and thank you very much, you have contributed something new to
    the repository!
10. Your merge request can now be merged in. Congratulations and thank you so much, you have contributed something new to
    the repository.


[@ap2-issue-tracker]: https://gitlab.cern.ch/allpix-squared/allpix-squared/issues
+2 −2
Original line number Diff line number Diff line
@@ -110,8 +110,8 @@ See [AUTHORS.md](./AUTHORS.md)

## Contributing to Allpix<sup>2</sup>

All types of contributions, being it minor and major, are very welcome. Please refer to our [contribution guidelines](CONTRIBUTING.md) for a description on how to get started.
Before adding changes it is very much recommended to carefully read through the documentation in the User Manual first.
All types of contributions, being it minor and major, are welcome. Please refer to our [contribution guidelines](CONTRIBUTING.md) for a description on how to get started.
Before adding changes it is highly recommended to carefully read through the documentation in the User Manual first.


## Licenses