source/snippets/README.md

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