README.md 2.03 KB
Newer Older
Enrique Garcia's avatar
Enrique Garcia committed
1
# template_escape
Enrique Garcia's avatar
Enrique Garcia committed
2
A simple example project to be used as a template.
3

Enrique Garcia's avatar
Enrique Garcia committed
4
It shows the **basic documentation** a project should include, following the [opensource guide](https://opensource.guide/starting-a-project/):
5

Enrique Garcia's avatar
Enrique Garcia committed
6 7 8 9 10 11 12 13 14 15 16
* An [open source](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#where-does-the-license-live-on-my-repository) **license**.
* A **README** [file](https://help.github.com/en/github/getting-started-with-github/create-a-repo#commit-your-first-change), similar to this one. 
* Contributing guidelines (see below).
* A code of conduct (TBD).
* It would be higly suitable to include too:
   - A setup file to install the library.
   - A .gitignore file.
   - The structure of the repository within a file with same name as the project.
   - Unitary and integration test.
   
**Please feel free to copy / base on / template this project!** (Look to left of the `Clone or download` button).
17

Enrique Garcia's avatar
Enrique Garcia committed
18
Take few minutes to check the [ESCAPE repository's guidelines](https://gitlab.in2p3.fr/escape2020/guidelines) too.
19

Enrique Garcia's avatar
Enrique Garcia committed
20
# Contributing guidelines
21

Enrique Garcia's avatar
Enrique Garcia committed
22
If you wish to provide software to the ESCAPE repository, you should ask developer access through the Gitlab inferface and send an email to vuillaume [at] lapp.in2p3.fr with your institution email.
23

Enrique Garcia's avatar
Enrique Garcia committed
24 25 26 27 28 29 30 31
You will then be able to open a new project and transfere code.

All the code provided should be uploaded from the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/). 

For a detailed explanation of how to submit a contribution to a project / repository (Fork, create a branch, make a Pull Resquest...), please check the [opensource guide](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) and or the [git's documentation](https://git-scm.com/doc).

# Citing 
Please do not forget to cite the ESCAPE repository ! (ESCAPE DOI will be available soon !)
32 33

## Report issue / Ask a question
Enrique Garcia's avatar
Enrique Garcia committed
34 35 36 37
Use [GitLab Issues](https://gitlab.in2p3.fr/groups/escape2020/-/issues).

# Contact
Email to vuillaume [at] lapp.in2p3.fr / garcia [at] lapp.in2p3.fr.