CONTRIBUTING.md

Contributing to Asqatasun

👍 First off, thanks for taking the time to contribute! 👍

We are really glad to have you on board !

Fill in bug reports

Fill in bug report.

• Please do not assign issue to anyone.
• You may assign an issue to yourself, meaning to others "I'm actually working on this issue".
• When closing an issue, please add a comment explaining why you are closing it.

Contribution to the code / Pull Request

Pre-requisites

• Docker
• Maven
• Git (of course)

Pre-requisites for Ubuntu 16.04

• Docker
• sudo apt install maven git

Choose or create an issue

Either choose an existing issue on which you'd like to work or create a new one. Identify its id. For example, the id of https://gitlab.com/asqatasun/Asqatasun/-/issues/115 is 115, we'll use it later.

Fork the project

From GitLab, fork the project. You've got your own personal Asqatasun under your GitLab user environment (https://gitlab.com/<user>/Asqatasun).

Work locally

git clone https://gitlab.com/<user>/Asqatasun.git
     # instead of:   git clone https://gitlab.com/asqatasun/Asqatasun.git
cd Asqatasun
git checkout -b <id-of-issue>-fix
     # git checkout -b 115-fix

Note: create a branch based on the master branch.

Code

Add your code, do your commits.

Test locally with Docker

./docker/build_and_run-with-docker.sh  --source-dir $(pwd) --docker-dir docker/SNAPSHOT-local

Check in your browser at http://localhost:8085/asqatasun/. You may compare with https://app.asqatasun.org/

Upload to your personal repos

git push origin <id-of-issue>-fix
     # git push origin 115-fix

Create the Pull Request / Merge Request

Create it:

• from your personal repos / your branch
• to the Asqatasun repos / master branch

Validate, a maintainer will review and hopefully merge your pull request.

Thank you for contributing to Asqatasun !

Resources

Those resources are meant to help:

• Asqatasun Contributor doc,
• and especially Asqatasun, Git, GitLab: getting started
• and anyway the Forum

Sources of inspiration for CONTRIBUTING.md

• For contributors doc Gitlab Workflow
• Atom's Contributing file that is really good and brightly written.