README.md 2.74 KB
Newer Older
Enrique Garcia's avatar
Enrique Garcia committed
1
# template_project_escape
Enrique Garcia's avatar
Enrique Garcia committed
2 3 4 5
<p align="center">
   <img src="https://cdn.eso.org/images/large/ann18084a.jpg" width="640" height="453"/>
</p>

Enrique Garcia's avatar
Enrique Garcia committed
6
A simple template project to provide software to ESCAPE.
7

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

Enrique Garcia's avatar
Enrique Garcia committed
10
* 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**.
Enrique Garcia's avatar
Enrique Garcia committed
11
* A [**README** file](https://help.github.com/en/github/getting-started-with-github/create-a-repo#commit-your-first-change), similar to this one. 
Enrique Garcia's avatar
Enrique Garcia committed
12 13
* Contributing guidelines (see below).
* A code of conduct (TBD).
14
* The structure of the repository.
Enrique Garcia's avatar
Enrique Garcia committed
15
* It would be highly suitable to include too:
Enrique Garcia's avatar
Enrique Garcia committed
16 17
   - A setup file to install the library.
   - A .gitignore file.
Enrique Garcia's avatar
Enrique Garcia committed
18
   - Unitary and integration tests.
Enrique Garcia's avatar
Enrique Garcia committed
19
   
Enrique Garcia's avatar
Enrique Garcia committed
20
**Please feel free to copy / base on / template this project!** (Look to left of the `Clone or download` button in the [GitHub](https://github.com/garciagenrique/template_project_escape) site).
21

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

Enrique Garcia's avatar
Enrique Garcia committed
24
# Contributing guidelines
25

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

28
You will then be able to open a new project and transfer code.
Enrique Garcia's avatar
Enrique Garcia committed
29 30 31

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

Enrique Garcia's avatar
Enrique Garcia committed
32 33 34 35 36
For a detailed explanation of how to submit a contribution to a project / repository (Fork, create a branch, make a pull request...), 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).

Once you are granted with developer access, you will be able to add a new blank project / import it (from other common repository managers, i.e., GitHub, GitLab, Bitbucket, Fogbugz...) to the [GitLab/ESCAPE](https://gitlab.in2p3.fr/escape2020) main page.

-  ***PLEASE NOTE*** that if you have login GitLab by using the `[Shibbolenth]` service (eduGAIN, Fédération d'Identités RENATER), you will need to [add a SSH key](https://gitlab.in2p3.fr/help/ssh/README#generating-a-new-ssh-key-pair) to your GitLab profile if you want to 'push' your changes to the server. 
Enrique Garcia's avatar
Enrique Garcia committed
37 38 39

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

Enrique Garcia's avatar
Enrique Garcia committed
41
# Report an issue / Ask a question
Enrique Garcia's avatar
Enrique Garcia committed
42 43 44 45
Use [GitLab Issues](https://gitlab.in2p3.fr/groups/escape2020/-/issues).

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