From 96da8b979750ed77b6939e5048de6a279729e886 Mon Sep 17 00:00:00 2001 From: Xoeseko Date: Fri, 10 Apr 2020 01:39:09 +0200 Subject: [PATCH] Added contribution section --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4e5e364..4873a02 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # Versusvirus2020 +## Contributing workflow +1. After having cloned this repository use `ng serve -o` to test locally (n.b: you might need a local Google Maps API key for some functionalities ask maintainers). +2. Take an existing issue from the backlog (click on it) and create a merge request (You can rename the branch to something more fitting). +3. Follow the instructions to checkout the branch locally. In your console run. + ``` + git fetch origin + git checkout -b "name-of-your-branch" "origin/name-of-your-branch" + ``` +4. Implement your feature or fix the bug and commit your changes. +5. Pull the latest changes from the master repository. (Resolve conflicts if necessary. In doubt ask maintainers) +6. Push the changes to your merge request branch. Remove "WIP" from title and assign a maintainer to review and merge your code. +7. If everything is fine your code will be merged to the staging branch where we can review the edits on http://test.yana.help. +8. Finally the maintainers will take care of merging all changes from staging onto master so that they can integrate the main site. + This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.4. ## Development server -- GitLab