add community docs

README.rst

@@ -281,7 +281,7 @@ macOS keyring. You should resign them manually to fix it. Error message::
 
 .. code-block:: bash
 
-    $ codesign -v `which python'
+    $ codesign -v `which python`
     /Users/user/.virtualenvs/builings/bin/python: invalid Info.plist (plist or signature have been modified)
     In architecture: x86_64
     $ codesign -f -s - `which python`
@@ -290,17 +290,17 @@ macOS keyring. You should resign them manually to fix it. Error message::
 Documentation
 -------------
 
-Documentation pages based on README.rst file and docstrings. Created for educational purposes.
+Documentation pages based on README.rst file and docstrings.
 
 -  http://umbr-api.readthedocs.io/en/latest/
 
 .. note::
-    A symbolic link README.rst --> docs/README.rst was used to create ToC in Sphinx, which doesn't support relative paths for ToC.
+    - A symbolic link README.rst --> docs/README.rst was used to create ToC in Sphinx, which doesn't support relative paths for ToC.
 
 Contribution guidelines
 -----------------------
 
--  https://github.com/kolatz/umbr_api
+-  https://github.com/kolatz/umbr_api/blob/master/docs/CONTRIBUTING.md
 
 Who do I talk to
 ----------------

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team via opening an issue in the repo. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+<https://www.contributor-covenant.org/faq>

docs/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to this repo
+
+## Communications
+
+Thank you for interest to this repository. Please use GitHub issues to
+discuss topics below before making any changes:
+
+- Reporting a bug
+- Reporting a security issue
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Submitting pull requests
+
+This repo is created mostly for education purposes. No guarantees that
+your pull requests will be accepted, sorry about that. But, feel free
+to clone the repo and do whatever you want.
+
+To submit your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code fully lints including optional linters.
+6. Issue that pull request.
+
+## Report bugs using GitHub's [issues](https://github.com/kolatz/umbr_api/issues)
+
+We use GitHub issues to track public bugs. Report a bug by
+[opening a new issue](https://github.com/kolatz/umbr_api/issues/new).
+
+### Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+    - Be specific!
+    - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+## Use a Consistent Formatting Style
+
+We honor `black` to automatically format all Python code. Please use it to
+maintain a consistent formatting style.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under
+it's [MIT License](http://choosealicense.com/licenses/mit/). Feel free
+to open an issue if that's a concern.
+
+## References
+
+This document was adapted from the open-source contribution guidelines for
+[Facebook's Draft.js](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

docs/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] "
+labels: bug
+assignees: ''
+
+---
+
+## Please write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+    - Be specific!
+    - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough good bug reports.

docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,57 @@
+# Pull Request Template
+
+Thank you for your contribution to this repo. Before submitting this PR,
+please review and edit all necessary parts of this template:
+
+## Description
+
+Please include a summary of proposing changes and which issue is fixed or
+features are added. Please also include relevant motivation and context.
+List any dependencies that are required for this change.
+
+## Related Issue
+
+This project only accepts pull requests related to open issues. If suggesting
+a new feature or change, please discuss it in an issue first. If fixing a bug,
+there should be an issue describing it with steps to reproduce. Please list all
+related issues.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce. Please also list any relevant details
+for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+
+- OS version
+- Umbrella subscription type
+- Python and modules versions
+
+## Checklist
+
+- [ ] I am fully conforming with Code of Conduct
+- [ ] I am running the latest version from `master` branch
+- [ ] I checked the documentation and found no answer
+- [ ] I checked to make sure that this issue has not already been filed by somebody else
+- [ ] I opened an issue to discuss and describe issues/features
+- [ ] I performed a self-review of my own code
+- [ ] My code follows the style guidelines of this project
+- [ ] I commented my code, particularly in hard-to-understand areas
+- [ ] I made corresponding changes to the the tests that prove my fix is effective or that my features work
+- [ ] I made corresponding changes to the documentation
+- [ ] I ran all linters checks and they generate no new warnings/errors
+- [ ] New and existing unit tests pass locally with my changes and generate no new warnings/errors
+- [ ] Any dependent changes have been merged and published in downstream modules