docs: add contributing guidelines

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## v0.1a1.dev7
+## v0.1a1
+
+### Documentation
+
+   - Add contributing guidelines
+
+## v0.1a1.dev7 - 2020-06-19
 
 ### Documentation
 
@@ -44,7 +50,7 @@
    - Add multiple tests for `DeepLinkMenu` ([b92f22086d0f958a895e487b6de3b8f199de537f](https://github.com/hearot/pyrubrum/commit/b92f22086d0f958a895e487b6de3b8f199de537f))
    - Add multiple tests for `DictDatabase` ([4682b54f227b5cbd4f9ce7d968188a9e8021781d](https://github.com/hearot/pyrubrum/commit/4682b54f227b5cbd4f9ce7d968188a9e8021781d))
    - Add multiple tests for `LinkMenu` ([929622547de7795afb2619d4ea4a19b1891434c7](https://github.com/hearot/pyrubrum/commit/929622547de7795afb2619d4ea4a19b1891434c7))
-   - Add multiple tests for `Menu`
+   - Add multiple tests for `Menu` ([d3cf32677bfd36f1817586a655bab8958e8f21f6](https://github.com/hearot/pyrubrum/commit/d3cf32677bfd36f1817586a655bab8958e8f21f6))
    - Add multiple tests for `Node` and `transform` ([7d9fa0a1a874316993a2ee8c50f5deeb22931abf](https://github.com/hearot/pyrubrum/commit/7d9fa0a1a874316993a2ee8c50f5deeb22931abf))
 
 ### ‼️ Breaking changes

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the maintainers of this repository, in particular [Hearot](https://github.com/hearot), before making a change.
+
+Please note we have a [code of conduct](./CODE_OF_CONDUCT.md); you **must** follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure you installed all the development requirements and make sure you tested all the examples and the tests with `pytest`.
+2. Commit following [Conventional Commits](https://www.conventionalcommits.org).
+3. You may merge the Pull Request in once you have the approval of all the maintainers.

FEATURES.md

@@ -1,52 +1,3 @@
 ### Documentation
 
-   - Add a flowchart for `cafe_bot.py` ([3664a0ad9f51c434c00fd6e4cf2d603e6953b530](https://github.com/hearot/pyrubrum/commit/3664a0ad9f51c434c00fd6e4cf2d603e6953b530))
-   - Add a flowchart for `calendar_bot.py` ([f7b41b594d62a2874a280bb93b4b1ea419ea35d1](https://github.com/hearot/pyrubrum/commit/f7b41b594d62a2874a280bb93b4b1ea419ea35d1))
-   - Add a flowchart for `hitchhiker_bot.py` ([3f7057244f3e1c868e0e7b00f04e39d481468a6d](https://github.com/hearot/pyrubrum/commit/3f7057244f3e1c868e0e7b00f04e39d481468a6d))
-   - Add a flowchart for `sample_bot.py` ([a698a4f1c7b85640011f861b9f2ae6ffa5dbd001](https://github.com/hearot/pyrubrum/commit/a698a4f1c7b85640011f861b9f2ae6ffa5dbd001))
-   - Add a license notice to the documentation (resolve #7) ([54bf64e414f5d8315d687938e56fb01548e2c67f](https://github.com/hearot/pyrubrum/commit/54bf64e414f5d8315d687938e56fb01548e2c67f))
-   - Add a reference to the author's GPG public key ([0054e2af66d239d2d60aa8c2e26fe7f32747dfaa](https://github.com/hearot/pyrubrum/commit/0054e2af66d239d2d60aa8c2e26fe7f32747dfaa))
-   - Add a simple glossary ([0000e5ecc76f27f66833a28ef67836b5a338a353](https://github.com/hearot/pyrubrum/commit/0000e5ecc76f27f66833a28ef67836b5a338a353))
-   - Add a simple quickstart menu ([3b4e5c7581ec4457bc8427068524954ec4920418](https://github.com/hearot/pyrubrum/commit/3b4e5c7581ec4457bc8427068524954ec4920418))
-   - Add a tip for opening a feature request ([909dfff2923e8b551d4500f48223659cd1d97ec4](https://github.com/hearot/pyrubrum/commit/909dfff2923e8b551d4500f48223659cd1d97ec4))
-   - Add docstrings to `command_filter` and `deep_link_filter` ([b61629afa1d85f80fea4ec5030ab756d47714fea](https://github.com/hearot/pyrubrum/commit/b61629afa1d85f80fea4ec5030ab756d47714fea))
-   - Add flowchart guidelines ([5f8b39464dd2558ef8792ab2f554f25e9d65d8a0](https://github.com/hearot/pyrubrum/commit/5f8b39464dd2558ef8792ab2f554f25e9d65d8a0))
-   - Add flowcharts ([c170d6aa8630e2f0575e79e0b10dcb5bab84a119](https://github.com/hearot/pyrubrum/commit/c170d6aa8630e2f0575e79e0b10dcb5bab84a119))
-   - Finish writing the tutorial ([3ed75930ab0a57d84dad25880bdde86e1e7d66f4](https://github.com/hearot/pyrubrum/commit/3ed75930ab0a57d84dad25880bdde86e1e7d66f4))
-   - Flowcharts are now transparent ([0c32a87eb5610b4b4304ab43eea4b706da69f224](https://github.com/hearot/pyrubrum/commit/0c32a87eb5610b4b4304ab43eea4b706da69f224))
-   - Include examples in the toctree ([737c1223e9ef4c95d9cac78c43e8820f7210069f](https://github.com/hearot/pyrubrum/commit/737c1223e9ef4c95d9cac78c43e8820f7210069f))
-   - Make the glossary terms highlight within the documentation ([5bb5d735a1db8081cacb41768ed1ca205ce79514](https://github.com/hearot/pyrubrum/commit/5bb5d735a1db8081cacb41768ed1ca205ce79514))
-   - Update docstrings for `pass_parameterized_handler` ([aa5a7a7b884db15a0c1c83b6d43bbf078fa58d4d](https://github.com/hearot/pyrubrum/commit/aa5a7a7b884db15a0c1c83b6d43bbf078fa58d4d))
-
-### Fixes
-
-   - Make all the flowcharts follow the guidelines ([5e308d275e81617b2ce2cb89181e43f2d086db94](https://github.com/hearot/pyrubrum/commit/5e308d275e81617b2ce2cb89181e43f2d086db94))
-   - Make the documentation consistent by deleting wrong content ([48c8efaf0efe95e86cc25decf0670920441781fe](https://github.com/hearot/pyrubrum/commit/48c8efaf0efe95e86cc25decf0670920441781fe))
-   - Preserve order while adding a new child to a node ([8a0980c41c18b67d98830d00db10b77c59a85c07](https://github.com/hearot/pyrubrum/commit/8a0980c41c18b67d98830d00db10b77c59a85c07))
-
-### New features
-
-   - Add `cafe_bot.py` as an example for multiple commands ([bacce5d540c3e4f36070ce4b554089381aa151fc](https://github.com/hearot/pyrubrum/commit/bacce5d540c3e4f36070ce4b554089381aa151fc))
-   - Do not store parameters related to null-pointer buttons ([2f43274ba12086b19540021f1197aa4de2770436](https://github.com/hearot/pyrubrum/commit/2f43274ba12086b19540021f1197aa4de2770436))
-
-### Other changes
-
-   - Delete references to LGPLv3 ([a7334b1a32b369239db8f1ec997cf2467d3c9420](https://github.com/hearot/pyrubrum/commit/a7334b1a32b369239db8f1ec997cf2467d3c9420))
-   - Exclude generated reStructuredText files ([4767232558cd0dc9788796d908294a783762e792](https://github.com/hearot/pyrubrum/commit/4767232558cd0dc9788796d908294a783762e792))
-   - Update version to 0.1a1.dev7 ([f9190b87c11822203511b8784e5f4248313a59e4](https://github.com/hearot/pyrubrum/commit/f9190b87c11822203511b8784e5f4248313a59e4))
-
-### Testing changes
-
-   - Add multiple tests for `DeepLinkMenu` ([b92f22086d0f958a895e487b6de3b8f199de537f](https://github.com/hearot/pyrubrum/commit/b92f22086d0f958a895e487b6de3b8f199de537f))
-   - Add multiple tests for `DictDatabase` ([4682b54f227b5cbd4f9ce7d968188a9e8021781d](https://github.com/hearot/pyrubrum/commit/4682b54f227b5cbd4f9ce7d968188a9e8021781d))
-   - Add multiple tests for `LinkMenu` ([929622547de7795afb2619d4ea4a19b1891434c7](https://github.com/hearot/pyrubrum/commit/929622547de7795afb2619d4ea4a19b1891434c7))
-   - Add multiple tests for `Menu`
-   - Add multiple tests for `Node` and `transform` ([7d9fa0a1a874316993a2ee8c50f5deeb22931abf](https://github.com/hearot/pyrubrum/commit/7d9fa0a1a874316993a2ee8c50f5deeb22931abf))
-
-### ‼️ Breaking changes
-
-   - Add `LinkMenu` ([2776ae7fd71649cb5fc2756665d931755379c678](https://github.com/hearot/pyrubrum/commit/2776ae7fd71649cb5fc2756665d931755379c678))
-   - Add `pyrubrum.menus.styles` and the `style` argument ([fbcfe0f63c4ecbab228f28942177d17d59d3dcb9](https://github.com/hearot/pyrubrum/commit/fbcfe0f63c4ecbab228f28942177d17d59d3dcb9))
-   - Consider valid only the queries sent from the same user ([6f8d9310c7bf52fc3f9f888061f84d7394453b17](https://github.com/hearot/pyrubrum/commit/6f8d9310c7bf52fc3f9f888061f84d7394453b17))
-   - Implement md5 encryption for parameterized handlers ([2f790256744a41b21956ae9acc867f1eb33a1496](https://github.com/hearot/pyrubrum/commit/2f790256744a41b21956ae9acc867f1eb33a1496))
-   - Support deep-linking ([c70cd3010b739d8b0f3bd013dfdb70faedb4ab8e](https://github.com/hearot/pyrubrum/commit/c70cd3010b739d8b0f3bd013dfdb70faedb4ab8e))
+   - Add contributing guidelines

MANIFEST.in

@@ -1,4 +1,5 @@
 include CHANGELOG.md
+include CONTRIBUTING.md
 include examples/sample.env
 include examples/requirements.txt
 recursive-include examples *.py

README.md

@@ -63,6 +63,10 @@ In order to make use of the proposed examples, you need to create your own envir
 
 > See [Conventional Commits](https://www.conventionalcommits.org).
 
+### Contributing
+
+> See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
 ### Versioning
 
 > See [PEP 440](https://www.python.org/dev/peps/pep-0440/).

docs/source/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the maintainers of this repository, in particular [Hearot](https://github.com/hearot), before making a change.
+
+Please note we have a [code of conduct](_static/CODE_OF_CONDUCT.md); you **must** follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure you installed all the development requirements and make sure you tested all the examples and the tests with `pytest`.
+2. Commit following [Conventional Commits](https://www.conventionalcommits.org).
+3. You may merge the Pull Request in once you have the approval of all the maintainers.

docs/source/_static/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the maintainers of this repository, in particular [Hearot](https://github.com/hearot), before making a change.
+
+Please note we have a [code of conduct](./CODE_OF_CONDUCT.md); you **must** follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure you installed all the development requirements and make sure you tested all the examples and the tests with `pytest`.
+2. Commit following [Conventional Commits](https://www.conventionalcommits.org).
+3. You may merge the Pull Request in once you have the approval of all the maintainers.

docs/source/conf.py

@@ -65,6 +65,7 @@
 root_files = [
     "CHANGELOG.md",
     "CODE_OF_CONDUCT.md",
+    "CONTRIBUTING.md",
     "LICENSE",
     "NOTICE",
     "README.md",
@@ -111,11 +112,12 @@
 
 copyfile("../../examples/sample.env", "_static/examples/sample.env")
 
-with open("README.md", "r", encoding="utf-8") as readme:
-    content = readme.read().replace("./", "_static/")
+for root_file in root_files:
+    with open(root_file, "r", encoding="utf-8") as markdown_file:
+        content = markdown_file.read().replace("./", "_static/")
 
-with open("README.md", "w", encoding="utf-8") as readme:
-    readme.write(content)
+    with open(root_file, "w", encoding="utf-8") as markdown_file:
+        markdown_file.write(content)
 
 # The full version, including alpha/beta/rc tags
 release = pyrubrum.__version__

docs/source/index.rst

@@ -84,6 +84,7 @@ Welcome to Pyrubrum
     Assets <https://github.com/hearot/pyrubrum-assets>
     CHANGELOG
     Code of Conduct <CODE_OF_CONDUCT>
+    CONTRIBUTING
     flowchart
     glossary
     license

pyrubrum/__init__.py

@@ -22,7 +22,7 @@
 __license__ = "GNU General Public License v3"
 __package__ = "pyrubrum"
 __url__ = "https://github.com/hearot/pyrubrum"
-__version__ = "0.1a1.dev7"
+__version__ = "0.1a1"
 
 from .database import BaseDatabase  # noqa
 from .database import DictDatabase  # noqa