add contributing file #131

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# CONTRIBUTING in ParlaMint
+
+
+
+## Git and GitHub
+
+Sample data should be pushed to the Data branch of the ParlaMint repository directly into the parliament folder (*`Data/ParlaMint-XX`*) in a flat structure of files.
+
+### Setup
+
+- [Create a GitHub account](https://github.com/signup) if you don't have one.
+- [Fork ParlaMint repository](https://github.com/clarin-eric/ParlaMint/fork) into your organization or private account.
+- Start the terminal on your computer and navigate to the folder where you want the ParlaMint local clone of the repository to be placed:
+
+```bash
+# replace <USER-ORG> with your GitHub user or organization name
+ git clone [email protected]:<USER-ORG>/ParlaMint.git
+```
+
+- Set the data branch in your repository to be synchronized with the data branch in the ParlaMint repository:
+
+```bash
+cd ParlaMint
+git fetch upstream
+git checkout -b data upstream/data
+git push -u origin data
+```
+
+### Adding new data into your remote repository (Fork)
+- check you are in the data branch
+
+```bash
+git status
+# switch do data branch:
+git checkout data
+```
+- Update your local git repository with your remote repository
+
+```bash
+git pull
+```
+
+- Add new data to your local git repository:
+
+```bash
+# replace XX with your country code
+git add Data/ParlaMint-XX/*.xml
+git commit -m ‘XX’ Data/ParlaMint-XX/ParlaMint-XX*.xml
+```
+
+- Push data to your Fork:
+
+```bash
+git push
+```
+
+### Synchronize your remote repository with the ParlaMint repository
+
+- update your repository with new content in ParlaMint repository:
+  - create a pull request: https://github.com/USER-ORG/ParlaMint/compare/data...clarin-eric:data
+  - check changes
+  - merge pull request
+- update ParlaMint repository with data in your repository:
+ - create a pull request: https://github.com/clarin-eric/ParlaMint/compare/data...USER-ORG:data
+
+
+## Local validation
+
+Running *`make help`* in the repository root folder provides a make targets list with a description.