source/snippets/README.md

0001 # snippets
0002
0003 A repository to share user-created snippets: macros, scripts, plugins, and more related
0004 to software, hardware data, and analysis at the Electron-Ion Collider (EIC).  Note that this
0005 repository is intended solely to share useful code snippets, and any code committed here
0006 has no guarantee of maintenance.
0007
0008 [![Monthly Commits](https://img.shields.io/github/commit-activity/m/eic/snippets.svg)](https://github.com/eic/snippets/commits/main)
0009 [![Last Commit](https://img.shields.io/github/last-commit/eic/snippets.svg)](https://github.com/eic/eic/snippets/commits/main)
0010 [![Download Size](https://img.shields.io/github/languages/code-size/eic/snippets.svg)](https://github.com/eic/snippets/archive/main.zip)
0011
0012 All members of the [EIC Github Organization](https://github.com/eic) have read/write access and
0013 are welcome to push your code directly to the main branch, no pull requests required!  It is
0014 strongly encouraged, however, to follow the recommendations listed below.
0015
0016 ### Recommendations
0017
0018  * When adding code, it is suggested to include either a README or provide sufficient comments in the code
0019    which details basic usage, inputs, outputs, and so on.
0020  * There are several directories corresponding to the different focus groups within the EIC (e.g. JetsAndHF,
0021    Tracking, etc.). In order to make it easier for others to find, it is suggested that you add your code
0022    to the relevant directory.
0023  * While no pull requests are required, we do ask that you follow standard etiquette for contributing to a
0024    shared repository (e.g. always pull before you push).