Skip to content

Latest commit

 

History

History
96 lines (79 loc) · 5.91 KB

CONTRIBUTING.md

File metadata and controls

96 lines (79 loc) · 5.91 KB
Raw

WELCOME TO GISWATER CONTRIBUTORS GUIDE (giswater_dbmodel)

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on https://github.com/Giswater/ repos. As well as License is GNU-GPL3 the contributions need to be made under same License, it means that it applies the inbound=outbound approach.

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

You can find more information about our code of conduct on: https://github.com/Giswater/docs/blob/master/github/pdf/code_of_conduct.pdf

As well as Giswater is developed in Python (qgis plugin) and PL/SQL(PostgreSQL database) there are three main repositories to manage it (QGIS-PLUGIN, DB-MODEL and DOCS). Right now this is the repository for the DB-MODEL.

TABLE OF CONTENTS

1- Bug report.
2- Working with issues.
3- Make new code contribution.
4- Contributors list.

BUG REPORT

If you’re experiencing a problem while working with Giswater, please, report it so our developers can revise and fix it, by submitting the following information and sending an e-mail to [email protected]

  1. Contact Information: name and e-mail address.
  2. Identification of the problem: many times a screenshot is enough.
  3. Detail of what happened: if the problem is reproducible, please mention the necessary steps that created it. If the problem is not reproducible (only happened once, or occasionally for no apparent reason) please describe the circumstances in which it occurred and the symptoms observed.
  4. Send a screenshot of the project check report.

How to get the project report?.
This report is generated by clicking on the button ‘Check project' on utilities toolbar.
After a few seconds an extensive report for project status is generated within a dialog. Screenshot of this dialog should be sent such that (at least errors & warnings).
More information: https://www.giswater.org/bug-report

WORKING WITH ISSUES

Create a new issue:

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue:

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

MAKE NEW CODE CONTRIBUTION

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions.

Finding ways to contribute with project:

  • Set up Git.
  • GitHub flow.
  • Collaborating with pull requests.
  • Getting started.
  • To navigate our codebase with confidence, see the introduction to working in the docs repository.

Choose te repo:

To make new code you need to choose what repo are you looking for:
Use the https://github.com/Giswater/docs repository to work with DOCS
Use the https://github.com/Giswater/giswater_qgis_plugin repository to work with PYTHON QGIS PLUGIN.
Use the https://github.com/Giswater/giswater_dbmodel repository to work with DATABASE MODEL.
Rest of repositories are no significant. Some of them they are deprecated or some of them are not used yet.

Make changes locally:

1- Install Git LFS.
2- Fork the repository.
3- Using GitHub Desktop.
4- Getting started with GitHub Desktop will guide you through setting up Desktop.
5- Once Desktop is set up, you can use it to fork the repo!
6- Using the command line: Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them. 7- Create a working branch and start with your changes!
8- Commit your update.
9- Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.
10- Once your changes are ready, don't forget to self-review to speed up the review process.

Create Pull Request:

When you're finished with the changes, create a pull request, also known as a PR.
Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. Don't forget to link PR to issue if you are solving one.
Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments.
As you update your PR and apply changes, mark each conversation as resolved. Once your PR is merged, your contributions will be publicly visible on the GitHub.

CONTRIBUTORS LIST

Adrian Valenciano, Frelance GIS consultant.
Nicole Aguiar, Frelance GIS consultant.
Jordi Blanch, Stagier on BGEO OPEN GIS.
Guillem Esteve, Stagier on BGEO OPEN GIS.
Elies Bertran, Stagier on BGEO OPEN GIS.
Ivan Moreno, Stagier on BGEO OPEN GIS.
Eter Gorgiladze, Stagier on BGEO OPEN GIS.
Luigi Pirelli, Freelance GIS developer.
Vicente Medina, Barcelona Tech university.
Xavier Calatrava, Aigües de Blanes, SA.
Diego Guedes, SANEAGO.
Pablo Marques, SANEAGO.
Abel Garcia Juanes, Frelance GIS consultant.
Natasa Cica, GIS developer on BGEO OPEN GIS.
Sergi Muñoz, GIS analyst on BGEO OPEN GIS.
Sergi Maspons, GIS analyst on BGEO OPEN GIS.
David Erill, Freelance GIS developer.
Nestor Ibáñez, GIS developer on BGEO OPEN GIS.
Edgar Fuste, GIS developer on BGEO OPEN GIS.
Albert Bofill, GIS analyst on BGEO OPEN GIS.
Barbara Rzepka, GIS analyst on BGEO OPEN GIS.
Xavier Torret, GIS analyst on BGEO OPEN GIS.