Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
132 lines (91 loc) · 5.86 KB

CONTRIBUTING.md

File metadata and controls

132 lines (91 loc) · 5.86 KB
Raw

Welcome to Giswater Contributors Guide - QGIS Plugin

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on Giswater GitHub repositories. Contributions follow the GNU-GPL3 License, meaning the inbound=outbound approach applies.

In this guide, you will get an overview of the contribution workflow, from opening an issue, creating a PR, reviewing, and merging it.

For more information, refer to our Code of Conduct.

Giswater is developed in Python (QGIS plugin) and PL/SQL (PostgreSQL database), with three main repositories: QGIS-PLUGIN, DB-MODEL, and DOCS. This guide applies to the QGIS-PLUGIN repository.

Table of Contents

  1. Bug Report
  2. Working with Issues
  3. Make New Code Contribution
  4. Contributors List

Bug Report

If you’re experiencing an issue with Giswater, please report it by sending an email to bugreport@giswater.org with the following information:

  1. Contact Information: Name and email address.
  2. Identification of the Problem: A screenshot is often sufficient.
  3. Details of the Issue: If reproducible, include the steps to recreate it. If not, describe the circumstances and observed symptoms.
  4. Project Check Report Screenshot: This report is generated by clicking ‘Check project’ on the utilities toolbar. A dialog will display errors and warnings. Send a screenshot of this dialog.

More information: Bug Report Guide.

Working with Issues

Create a New Issue

If you spot a documentation problem, search to see if an issue already exists. If not, open a new issue using a relevant issue form.

Solve an Issue

Browse existing issues to find one that interests you. Use labels to filter your search. As a general rule, we don’t assign issues. If you find an issue to work on, open a PR with a fix.

Make New Code Contribution

To understand the project, start with the README. Here are some resources to get you started with open source contributions.

Finding Ways to Contribute

Choose the Repository

To make a new code contribution, select the appropriate repository:

Make Changes Locally

  1. Install Git LFS.
  2. Fork the repository.
  3. Set up GitHub Desktop or use command line.
  4. Create a working branch and begin changes.
  5. Commit changes when satisfied, using Conventional Commits.
  6. Self-review to expedite the review process.

Commit messages

Use Conventional Commits: type(optional-scope): subject in imperative English.

Common types: fix, feat, refactor, chore, docs, test, ci. Examples: fix(sql): handle null language in patch, feat(epsg): detect project EPSG from sys_version.

Prefer the same type in the PR title.

Create a Pull Request

Once finished, open a PR. GitHub fills the pull request template: mark the type, write a short Summary, complete the Test plan, and link any related issue (Closes #N / Refs #N). Enable maintainer edits for branch updates. A team member will review your PR, possibly requesting changes before merging.

Contributors List

Josep Lluís Sala, GIS analyst on BGEO OEPN GIS.
Xavier Torret, GIS and Database analyst on BGEO OPEN GIS.
Albert Bofill, GIS and Database analyst on BGEO OPEN GIS.
Maria Guzman, GIS and Database analyst on BGEO OPEN GIS.
Barbara Rzepka, GIS and Database on BGEO OPEN GIS.
Namrata Karki, GIS-Engineering Consultant on BGEO OPEN GIS.

Edgar Fuste, Full Stack developer on BGEO OPEN GIS.
Jordi Blanch, Full Stack developer on BGEO OPEN GIS.
Lia Bertran, Full Stack developer on BGEO OPEN GIS.
Sergi Maspons, Full Stack developer on BGEO OPEN GIS.

Natasa Cica, GIS developer on BGEO OPEN GIS.
Nestor Ibáñez, GIS developer on BGEO OPEN GIS.
Oscar Pueyo, GIS developer on BGEO OPEN GIS.

Daniel Marín, Back-End developer and Database analyst on BGEO OPEN GIS.
Arnau Urgeles, Back-End developer and Database analyst on BGEO OPEN GIS.
Nico Pérez, Back-End developer on BGEO OPEN GIS.
Ferran Martínez, Front-End developer on BGEO OPEN GIS.
Arnau Torret, i18n & Release Manager on BGEO OPEN GIS.

Sergi Muñoz, Engineering Projects Consultant on BGEO OPEN GIS.
David Cano, Engineering Projects Consultant on BGEO OPEN GIS.

Adrian Valenciano, Freelance GIS consultant.
Nicole Aguiar, Freelance GIS consultant.
Abel Garcia Juanes, Freelance GIS consultant.

Luigi Pirelli, Freelance GIS developer.
David Erill, Freelance GIS developer.

Guillem Esteve, Stagier on BGEO OPEN GIS.
Ivan Moreno, Stagier on BGEO OPEN GIS.
Eter Gorgiladze, Stagier on BGEO OPEN GIS.
Rafael Navarro, Stagier on BGEO OPEN GIS.
Lex Van Empel, Stagier on BGEO OPEN GIS.

Vicente Medina, Barcelona Tech University.
Xavier Calatrava, Aigües de Blanes, SA.
Diego Guedes, SANEAGO.
Pablo Marques, SANEAGO.
Claudia Dragoste, Aigües de Manresa, SA.
Josep Portero, Aigües de Mataró, SA.
Enric Amat, Fisersa, SA.
Sergi Grau, Aigües de Manresa, SA.
Pere Rodriguez, Aigües del Prat, SA.
Marc Vilaseca, Aigües de Vic, SA.

Commiters