Contributing to Asqatasun
:+1: First off, thanks for taking the time to contribute! :+1:
We are really glad to have you on board !
Fill in bug reports
- 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 for Ubuntu 16.04
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://github.com/Asqatasun/Asqatasun/issues/115 is
115, we'll use it later.
Fork the project
From Github, fork the project. You've got your own personal Asqatasun under your Github user environment (
git clone https://github.com/<user>/Asqatasun.git # instead of: git clone https://github.com/Asqatasun/Asqatasun.git cd Asqatasun git checkout develop git checkout -b <id-of-issue>-fix # git checkout -b 115-fix
(Note: create a branch based on the
Master is meant to be directly usable in production, thus only contains tagged releases).
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
Upload to your personal repos
git push origin <id-of-issue>-fix # git push origin 115-fix
Create the Pull Request / Merge Request
- from your personal repos / your branch
- to the Asqatasun repos /
Validate, a maintainer will review and hopefully merge your pull request.
Thank you for contributing to Asqatasun !
Those resources are meant to help:
- Asqatasun Contributor doc,
- and especially Asqatasun, Git, Github: getting started
- and anyway the Forum