From 8276d37d289c516c0353984819d3c8b9909accc2 Mon Sep 17 00:00:00 2001 From: pedrorrivero Date: Tue, 9 Jan 2024 15:51:03 +0000 Subject: [PATCH] chore(template): merge template changes --- CONTRIBUTING.md | 5 ++--- FILEMAP.md | 2 ++ 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65bfc46..a2ed3dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,6 @@ Other than submitting new source code, users can contribute in a number of meani - _Opening an issue_ in the repository for reporting bugs, enhancements, or requesting new features. - _Starting a conversation on GitHub Discussions_ and engaging with researchers, developers, and other users regarding this project. -- Filling out our [survey](https://airtable.com/shr7sMAKUAjuIRpv7). ## Initial set-up @@ -90,11 +89,11 @@ tox -e style We adhere to the [google docstring guide](https://docs.idmod.org/projects/doc-guidance/en/latest/docstrings.html). If you make any changes to the code, remember updating the docstring wherever relevant. ### Copyright notice -All source files in the repository must begin with the appropriate copyright notice. For instance, for the year 2023: +All source files in the repository must begin with the appropriate copyright notice. For instance, for the year 2024: ```python # This code is part of Qiskit. # -# (C) Copyright IBM 2023. +# (C) Copyright IBM 2024. # # This code is licensed under the Apache License, Version 2.0. You may # obtain a copy of this license in the LICENSE.txt file in the root directory diff --git a/FILEMAP.md b/FILEMAP.md index a1df33e..07f16a3 100644 --- a/FILEMAP.md +++ b/FILEMAP.md @@ -22,6 +22,8 @@ - `` -- it will have a different name for each repository using the [`pyproject-qiskit` template](https://github.com/pedrorrivero/pyproject-qiskit), and it holds the source code for the software package. This name will determine how the package is imported after installation (e.g. `from import __version__`). +- [`CHANGELOG.md`](CHANGELOG.md) -- + file that logs all the changes made to the software package on each new version release. - [`docs`](docs) -- documentation for the repository (e.g. tutorials, API docs, reference guide). - [`test`](test) --