Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Developer Certificate of Origin #70

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Please note this documentation assumes you already have `virtualenv` and `Git` i
.. code-block:: bash

git add .
git commit -m "Your detailed description of your changes."
git commit -s -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

#. Submit a pull request through the GitHub website.
Expand All @@ -135,6 +135,14 @@ Before you submit a pull request, check that it meets these guidelines:
#. The pull request should work for Python 3.8 up to Python 3.13, and for PyPy 3.11 and PyPy 3.12.
Check https://github.com/Ouranosinc/cookiecutter-pypackage/actions/workflows/main.yml and make sure that the tests pass for all supported Python versions.

#. If you haven't already, ensure that you have read and agreed to the `Developer Certificate of Origin (DCO) <https://developercertificate.org/>`_, and that you have signed your commits using:

.. code-block:: bash

git commit --signoff/-s

This will add a `Signed-off-by:` line to your commit message, which indicates that you agree to the DCO.

Add a New Test
--------------

Expand Down
16 changes: 10 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ Cookiecutter_ template for a Python package.
Features
--------

* Testing setup with ``unittest`` with ``coverage run`` or ``pytest``
* Testing setup with ``unittest`` or ``pytest`` (with support for code coverage via `Coveralls`_).
* `pyproject.toml`_ with the flit_ backend for PEP 517/621-compliant packaging.
* `GitHub Actions`_: Ready for GitHub Actions Continuous Integration testing and Deployment.
* `Conda`_ environment file: Optionally use ``conda env create -f environment-dev.yml`` to create a new environment with the correct Python version.
* Conda_ environment file: Optionally use ``conda env create -f environment-dev.yml`` to create a new environment with the correct Python version.
* Tox_ testing: Setup to easily test for Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, and PyPy3.
* Sphinx_ docs: Documentation ready for generation with, for example, `Read the Docs`_
* pre-commit_ hook: Run your tests and linting (e.g. `black`, `flake8`, `pylint`, etc.) before you commit your code!
* `pre-commit.ci`_: Automate `pre-commit` checks and corrections in your Pull Requests.
* bump-my-version_: Pre-configured `SemVer-2.0-compliant`_ version bumping with a single command.
* dependabot_ for automated dependency updates of both project dependencies and GitHub Actions.
* `sphinx-intl`_ for French internationalization (i18n) and localization (l10n) of Sphinx docs (optional)
* Auto-release to TestPyPI_ and PyPI_ when you push a new tag to main (optional)
* Command line interface using Click (optional)
* `Developer Certificate of Origin`_ (DCO) enforcement support using `DCO App`_.
* sphinx-intl_ for French internationalization (i18n) and localization (l10n) of Sphinx docs (optional).
* Auto-release to TestPyPI_ and PyPI_ when you push a new tag to main (optional).
* Command line interface using Click (optional).

Build Status
-------------
Expand Down Expand Up @@ -157,6 +158,9 @@ I also accept pull requests on this, if they're small, atomic, and if they make
.. _Black: https://black.readthedocs.io/en/stable/
.. _Conda: https://docs.conda.io/en/latest/
.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _Coveralls: https://coveralls.io/
.. _DCO App: https://probot.github.io/apps/dco/
.. _Developer Certificate of Origin: https://developercertificate.org/
.. _GitHub Actions: https://docs.github.com/en/actions
.. _Mkdocs: https://pypi.org/project/mkdocs/
.. _Mypy: https://mypy.readthedocs.io/en/stable/
Expand All @@ -179,7 +183,7 @@ I also accept pull requests on this, if they're small, atomic, and if they make
.. _sphinx-intl: https://sphinx-intl.readthedocs.io/en/master/
.. _testpypi: https://test.pypi.org/

.. _GitHub comparison view: https://github.com/tony/cookiecutter-pypackage-pythonic/compare/audreyr:master...master
.. _GitHub comparison view: https://github.com/tony/cookiecutter-pypackage-pythonic/compare/audreyr:master...main
.. _Nekroze/cookiecutter-pypackage: https://github.com/Nekroze/cookiecutter-pypackage
.. _ardydedase/cookiecutter-pypackage: https://github.com/ardydedase/cookiecutter-pypackage
.. _briggySmalls/cookiecutter-pypackage: https://github.com/briggySmalls/cookiecutter-pypackage
Expand Down
5 changes: 5 additions & 0 deletions {{cookiecutter.project_slug}}/.github/dco.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---

allowRemediationCommits:
individual: true
thirdParty: true
10 changes: 9 additions & 1 deletion {{cookiecutter.project_slug}}/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Ready to contribute? Here's how to set up ``{{ cookiecutter.project_name }}`` fo
.. code-block:: console

git add .
git commit -m "Your detailed description of your changes."
git commit -s -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

If ``pre-commit`` hooks fail, try fixing the issues, re-staging the files to be committed, and re-committing your changes (or, if need be, you can skip them with `git commit --no-verify`).
Expand Down Expand Up @@ -209,6 +209,14 @@ Before you submit a pull request, check that it meets these guidelines:

#. The pull request should work for all currently supported Python versions. Check the `pyproject.toml` or `tox.ini` files for the list of supported versions.

#. If you haven't already, ensure that you have read and agreed to the `Developer Certificate of Origin (DCO) <https://developercertificate.org/>`_, and that you have signed your commits using:

.. code-block:: bash

git commit -s/--signoff

This will add a `Signed-off-by:` line to your commit message, which indicates that you agree to the DCO.

Tips
----

Expand Down
Loading