Browse Source

gin commit from nit-ope-de04

Modified files: 1
sprenger 3 years ago
parent
commit
8cf9f1bd20
1 changed files with 8 additions and 6 deletions
  1. 8 6
      README.md

+ 8 - 6
README.md

@@ -13,13 +13,13 @@ To contribute a dataset the following criteria need to be fulfilled
 
 ### How to add files
 
-You can suggest to add your files via a pull request by following the steps below
+To add files to the repository please follow the steps below.
 
-**On the [gin](https://gin.g-node.org) platform**
+**1) On the [gin](https://gin.g-node.org) platform**
 - Create a [gin account](https://gin.g-node.org/user/sign_up)
 - Open an issue stating the format of files you would like to add. Please specify in this issue, which type of system is generating these files and in which software your files could be used as testing files. After reviewing the proposed format you will be added as a collaborator to the project.
 
-**On your local computer**
+**2) On your local computer**
 - Install the gin client on your machine ([gin-cli setup instructions](https://gin.g-node.org/G-Node/Info/wiki/GIN+CLI+Setup))
 - Log in with your gin-cli (`gin login`)
 - Create a local copy of the repository on your machine (`gin get NeuralEnsemble/ephy_testing_data`)
@@ -30,12 +30,14 @@ You can suggest to add your files via a pull request by following the steps belo
 - Lock the files via `gin lock *`
 - Upload your changes to gin via `gin upload`
 
-**On the [gin](https://gin.g-node.org)  platform**
+*Note:* You can also commit files using any other git-annex capable tool. However, make sure that the `.gitattributes` specifications are respected and files are committed in a locked state.
+
+**3) On the [gin](https://gin.g-node.org)  platform**
 - The new branch `<my_branch_name>` should be available at the [webpage](https://gin.g-node.org/NeuralEnsemble/ephy_testing_data). Verify that the changes are correctly registered in this branch.
 - Open a pull request (PR) with your changes to the master branch of the `NeuralEnsemble/ephy_testing_data` repository. In your PR description please specify again what format you want to add, which type of system is generating these files and which software could make use of these.
-- You will potentially receive comments from the repository maintainers asking you to change some details in your PR.
+- You will potentially receive comments from the repository maintainers asking you to change some details in your PR. Please do **not** merge your own pull request!
 - After resolving the comments your files will be merged into the main repository.
 Congratulation! Your files are now part of the growing collection of electrophysiology testing files and can now be used by any project to check for file format compatibility.
 
 
-Note: Don't forget to switch back to the master branch after completion of your PR: `gin git checkout master`
+*Note:* Don't forget to switch back to the master branch after completion of your PR: `gin git checkout master`