Repository structure

Guidelines

CITATION.bib -- BibTeX file including the bibliographic reference to cite the software.
CODE_OF_CONDUCT.md -- participation in the repository is subject to these conduct guidelines.
CONTRIBUTING.md -- guidelines to contribute to the repository.
DEPRECATION.md -- deprecation policy.
FILEMAP.md -- a summary of the repository structure and explanations of the different files and folders.
INSTALL.md -- guidelines to install the software contained in this repo.
LICENSE.txt -- one of the standard legal requirements for an open source project. There are different types of licenses for software, some of the most popular being open source.
README.md -- main readme for repository.

<pyproject_qiskit> -- it will have a different name for each repository using the pyproject-qiskit template, and it holds the source code for the software. This name will determine how the software is imported after installation (e.g. from <pyproject_qiskit> import __version__).
CHANGELOG.md -- file that logs all the changes made to the software on each new version release.
docs -- documentation for the repository (e.g. tutorials, API docs, reference guide).
test -- folder where all project tests are located. It is a good practice to cover your project with tests to ensure correctness of implementation.
- acceptance -- folder for acceptance tests.
- integration -- folder for integration tests.
- system -- folder for system tests.
- unit -- folder for unit tests.
pyproject.toml -- file containing the build and package configurations for the python project. This file also contains configurations for:
- Black -- a tool for automatic code formatting.
- Autoflake -- a tool for removing unused imports and variables.

.cz.toml -- configuration file for commitizen, a tool for software release management.
.github -- folder for configuring anything related to GitHub.
- ISSUE_TEMPLATE -- folder holding the templates for issues in the repository.
- workflows -- configurations for GitHub Actions (e.g. CI/CD scripts).
- .templatesyncignore -- file declaring paths to be ignored by the template sync action.
- CODEOWNERS -- file defining individuals and teams that are responsible for code in the repository.
- PULL_REQUEST_TEMPLATE -- file holding the template for pull requests in the repository.
.gitignore -- git-specific file that tells which files to ignore when tracking/pushing/committing code (those files will not be tracked by git).
.pre-commit-config.yaml -- configuration for pre-commit, a framework for managing and maintaining git hooks.
.travis.yaml -- configuration file for Travis-CI; similar to GitHub Actions (e.g. CI/CD scripts).
tools -- auxiliary tools and scripts for repository maintenance.
- extremal_dependency_versions.py -- script for testing against minimum and development versions of specific dependencies.
- symlink_submodule.py -- auxiliary script to create symlinks to submodule files in base repo.
- travis_before_script.bash -- auxiliary script for extremal dependency testing using Travis-CI.

.coveragerc -- configuration for the code coverage tool used in testing.
coverage-html -- autogenerated folder holding html documents to explore code coverage after running the coverage tool. The entry point is coverage-html/index.html.
.flake8 -- configuration for Flake8, a tool for code style enforcing.
.gitlint -- configuration for Gitlint, a tool for checking commit message style.
.isort.cfg -- configuration for isort, a tool to sort and group python imports automatically.
.mypy.ini -- configuration for mypy, a tool to for static type checking in python via type annotations.
.pylintrc -- configuration for Pylint, a tool for static code analysis (e.g. lint errors).
pytest.ini -- configuration for the PyTest framework used for testing the software.
tox.ini -- configuration file for tox framework that aims to automate and standardize testing in Python. Eases the packaging, testing and release process of Python software.