Merge pull request #94 from LabSid-USP/development

Bump version to 1.11.0

.gitignore

@@ -73,6 +73,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+help/build/
+help/source/_build/
 
 # PyBuilder
 target/
@@ -120,6 +122,9 @@ venv.bak/
 # Visual Studio Code project settings
 .vscode
 
+# JetBrains PyCharm project settings
+.idea
+
 # Rope project settings
 .ropeproject
 
@@ -133,3 +138,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+

CITATION

@@ -0,0 +1,15 @@
+To cite RUBEM in publications use:
+
+    Méllo, A. V., L. M. O. Olivos, C. Billerbeck, S. S. Marcellini, W. D. Vichete, D. M. Pasetti, L. M. d. Silva, G. A. d. S. Soares, J. R. B. Tercini (2021). Rainfall-Runoff Balance Enhanced Model Applied to Tropical Hydrology, ?????, http://url
+
+A BibTeX entry for LaTeX users is
+
+  @article{,
+    title = {Rainfall-Runoff Balance Enhanced Model Applied to Tropical Hydrology},
+    author = {Méllo, A. V., L. M. O. Olivos, C. Billerbeck, S. S. Marcellini, W. D. Vichete, D. M. Pasetti, L. M. d. Silva, G. A. d. S. Soares, J. R. B. Tercini},
+    journal  = {??},
+    year     = {2021},
+    volume   = {??},
+    number   = {?},
+    pages    = {??--??},
+  }

CODE_OF_CONDUCT.md

@@ -0,0 +1,35 @@
+Code of Conduct
+===============
+
+Like the technical community as a whole, the RUBEM Hydrological team and community is made up of a mixture of professionals and volunteers from all over the world, working on every aspect of the mission - including mentorship, teaching, and connecting people.
+
+Diversity is one of our huge strengths, but it can also lead to communication issues and unhappiness. To that end, we have a few ground rules that we ask people to adhere to. This code applies equally to founders, mentors and those seeking help and guidance.
+
+This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - a guide to make it easier to enrich all of us and the technical communities in which we participate.
+
+This code of conduct applies to all spaces managed by the RUBEM Hydrological project. This includes live chat, mailing lists, the issue tracker, and any other forums created by the project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person’s ability to participate within them.
+
+If you believe someone is violating the code of conduct, we ask that you report it by emailing [rubem.hydrological+conduct@labsid.eng.br](mailto:rubem.hydrological+conduct@labsid.eng.br).
+
+- **Be friendly and patient.**
+
+- **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
+
+- **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we’re a world-wide community, so you might not be communicating in someone else’s primary language.
+
+- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the RUBEM Hydrological community should be respectful when dealing with other members as well as with people outside the RUBEM Hydrological community.
+
+- **Be careful in the words that you choose.** We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren’t acceptable. This includes, but is not limited to:
+
+  - Violent threats or language directed against another person;
+  - Discriminatory jokes and language;
+  - Posting sexually explicit or violent material;
+  - Posting (or threatening to post) other people’s personally identifying information ("doxing");
+  - Personal insults, especially those using racist or sexist terms;
+  - Unwelcome sexual attention;
+  - Advocating for, or encouraging, any of the above behavior;
+  - Repeated harassment of others. In general, if someone asks you to stop, then stop.
+
+- **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and RUBEM Hydrological is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of RUBEM Hydrological comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
+
+Original text courtesy of the [Speak Up! project](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html). This version was adopted from the [Django Code of Conduct](https://www.djangoproject.com/conduct/).

CONTRIBUTING.md

@@ -1,26 +1,59 @@
 # Contributing to RUBEM Hydrological
 
-Thanks for your time and willingness to contribute to RUBEM Hydrological! This page gives a few guidelines:
+Thanks for your time and willingness to contribute to RUBEM Hydrological! This page gives a few guidelines.
 
+## General questions
 
-**Reporting Bugs**
+Please do not use the issue tracker for support questions. You can send your questions, ideas and discussion issues to our [e-mail](mailto:rubem.hydrological@labsid.eng.br).
 
-If you have found a bug in the RUBEM Hydrological software (or any other erroneous behavior) please file a bug report. Any error messages containing the phrases: "assertion failed" or "programming error" are always related to errors in the software we should fix.
+## Reporting Bugs and Requesting Features
 
-Bugs are tracked on our GitHub [issue](https://github.com/LabSid-USP/RUBEMHydrological/issues) page. To allow us to reproduce the issue please provide:
+Bugs and features requests are tracked on our GitHub [issue](https://github.com/LabSid-USP/RUBEMHydrological/issues) page.
 
-- The RUBEM Hydrological version and the Python version used.
-- Details about the operating system used.
-- The description of the problem in as much detail as possible.
-- If possible, a minimal working example and zip or archive file with all data and scripts so we can reproduce the bug.
+If you have found a bug in the RUBEM Hydrological software (or any other erroneous behavior) please file a bug report. Before reporting a bug or requesting a new feature on the [issue tracker](https://github.com/LabSid-USP/RUBEMHydrological/issues), consider these points:
 
+- Check that someone hasn't already filed the bug or feature request by searching or running custom queries in the issue tracker;
 
-**General questions**
+- Don't use the issue page to ask support questions. Use the [support form](https://forms.gle/JmxWKoXh4C29V2rD8) for that;
 
-Please do not use the issue tracker for support questions. You can send your questions, ideas and discussion issues to our [e-mail](mailto:rubem.hydrological@labsid.eng.br).
+- Don't reopen issues that have been marked "wontfix" without finding consensus to do so.
+
+### Reporing bugs
+
+Well-written bug reports are incredibly helpful. However, there’s a certain amount of overhead involved in working with any bug tracking system so your help in keeping our issue tracker as useful as possible is appreciated. In particular:
+
+- Do read the [FAQ](https://github.com/LabSid-USP/RUBEMHydrological) to see if your issue might be a well-known question;
+
+- Do ask on our [support form](https://forms.gle/JmxWKoXh4C29V2rD8) first if you're not sure if what you're seeing is a bug;
+
+- Do write complete, reproducible, specific bug reports. You must include a clear, concise description of the problem, and a set of instructions for replicating it. Add as much debug information as you can: test cases, exception backtraces, screenshots, Python version, QGIS version, RUBEM Hydrological version, details about the operating system used,  etc. A nice small test case is the best way to report a bug, as it gives us a helpful way to confirm the bug quickly;
+
+### Reporing user interface bugs and features
+
+If your bug or feature request touches on anything visual in nature, there are a few additional guidelines to follow:
 
+- Include screenshots in your issue which are the visual equivalent of a minimal testcase. Show off the issue, not the customizations you’ve made to your QGIS;
 
-**Pull requests**
+- If the issue is difficult to show off using a still image, consider capturing a brief screencast. If your software permits it, capture only the relevant area of the screen.
+If you're offering a patch which changes the look or behavior of RUBEM Hydrological's UI, you must attach before and after screenshots/screencasts. Issues lacking these are difficult for triagers to assess quickly;
+
+- Screenshots don't absolve you of other good reporting practices. Make sure to include step-by-step instructions on how to reproduce the behavior visible in the screenshots.
+Make sure to set the UI/UX flag on the issue so interested parties can find your issue.
+
+### Requesting features
+
+We’re always trying to make RUBEM Hydrological better, and your feature requests are a key part of that. Here are some tips on how to make a request most effectively:
+
+- Make sure the feature actually requires changes in RUBEM Hydrlogical's core. If your idea can be developed as an independent application or module we'll probably suggest that you develop it independently;
+
+- Describe clearly and concisely what the missing feature is and how you'd like to see it implemented. Include example code (non-functional is OK) if possible;
+
+- Explain why you'd like the feature. Explaining a minimal use case will help others understand where it fits in, and if there are already other ways of achieving the same thing.
+If there's a consensus agreement on the feature, then it's appropriate to create a issue;
+
+As with most open-source projects, code talks. If you are willing to write the code for the feature yourself or, even better, if you’ve already written it, it’s much more likely to be accepted. Fork RUBEM Hydrological on GitHub, create a feature branch, and show us your work!
+
+## Pull requests
 
 In case you can provide a code fix yourself please consider submitting a [pull](https://github.com/LabSid-USP/RUBEMHydrological/pulls) request.
 
@@ -35,10 +68,9 @@ For something that is bigger than a trivial fix follow these steps:
 
 All contributions to this project will be released under the GPLv3 license under copyright of the RUBEM Hydrological owners. By submitting a pull request:
 
-- You are agreeing to comply with the waiver of your copyright interest.
+- You are agreeing to comply with the waiver of your copyright interest;
 - You state that the contribution was created in whole by you and you have the right to submit it.
 
+## Contacting us
 
-**Contacting us**
-
-For project related questions please contact us at [rubem.hydrological@labsid.eng.br](mailto:rubem.hydrological@labsid.eng.br).
+For other project related questions please contact us on our [support form](https://forms.gle/JmxWKoXh4C29V2rD8).