Add basic CONTRIBUTING.md template

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

cookiecutter/{{cookiecutter.github_repo_name}}/CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Contributing to {{cookiecutter.title}}
+
+## Build
+
+You can use `build` to simply build the source and binary distribution:
+
+```sh
+python -m pip install build
+python -m build
+```
+
+## Local development
+
+You can use editable installs to develop the project locally (it will install
+all the dependencies too):
+
+```sh
+python -m pip install -e .
+```
+
+Or you can install all development dependencies (`mypy`, `pylint`, `pytest`,
+etc.) in one go too:
+```sh
+python -m pip install -e .[dev]
+```
+
+If you don't want to install all the dependencies, you can also use `nox` to
+run the tests and other checks creating its own virtual environments:
+
+```sh
+python -m pip install .[dev-noxfile]
+nox
+```
+
+You can also use `nox -R` to reuse the current testing environment to speed up
+test at the expense of a higher chance to end up with a dirty test environment.
+
+### Running tests / checks individually
+
+For a better development test cycle you can install the runtime and test
+dependencies and run `pytest` manually.
+
+```sh
+python -m pip install .[dev-pytest]  # included in .[dev] too
+
+# And for example
+pytest tests/test_*.py
+```
+
+Or you can use `nox`:
+
+```sh
+nox -R -s pytest -- test/test_*.py
+```
+
+The same appliest to `pylint` or `mypy` for example:
+
+```sh
+nox -R -s pylint -- test/test_*.py
+nox -R -s mypy -- test/test_*.py
+```
+
+## Releasing
+
+These are the steps to create a new release:
+
+1. Get the latest head you want to create a release from.
+
+2. Update the `RELEASE_NOTES.md` file if it is not complete, up to date, and
+   clean from template comments (`<!-- ... ->`) and empty sections. Submit
+   a pull request if an update is needed, wait until it is merged, and update
+   the latest head you want to create a release from to get the new merged pull
+   request.
+
+3. Create a new signed tag using the release notes and
+   a [semver](https://semver.org/) compatible version number with a `v` prefix,
+   for example:
+
+   ```sh
+   git tag -s --cleanup=whitespace -F RELEASE_NOTES.md v0.0.1
+   ```
+
+4. Push the new tag.
+
+5. A GitHub action will test the tag and if all goes well it will create
+   a [GitHub
+   Release](https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}/releases),
+   and upload a new package to
+   [PyPI](https://pypi.org/project/{{cookiecutter.pypi_package_name}}/)
+   automatically.
+
+6. Once this is done, reset the `RELEASE_NOTES.md` with the template:
+
+   ```sh
+   cp .github/RELEASE_NOTES.template.md RELEASE_NOTES.md
+   ```
+
+   Commit the new release notes and create a PR (this step should be automated
+   eventually too).
+
+7. Celebrate!

cookiecutter/{{cookiecutter.github_repo_name}}/README.md

@@ -3,3 +3,8 @@
 {{cookiecutter.description}}
 
 TODO(cookiecutter): Improve the README file
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).