Skip to content

Commit

Permalink
docs: substitute word package with software to account for libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrorrivero committed Jan 29, 2024
1 parent 586be1b commit f902b88
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/.templatesyncignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs/
pyproject_qiskit/
test/
# PACKAGE
# SOFTWARE
.cz.toml
CITATION.bib
pyproject.toml
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Contributing
__We appreciate all kinds of help, so thank you!__

This guide is for those who want to extend the module or documentation. If you just want to use the package, read [this other guide](./docs/reference_guide.md) instead.
This guide is for those who want to extend the module or documentation. If you just want to use the software, read [this other guide](./docs/reference_guide.md) instead.


## Table of contents
Expand Down Expand Up @@ -43,7 +43,7 @@ Other than submitting new source code, users can contribute in a number of meani
## Initial set-up

### Installing dependencies
In order to contribute, you will need to [install the module from source](/INSTALL.md#installation-from-source) with developer dependencies (i.e. `dev` bundle) and, optionally, in editable mode. We recommend using the latest version of python available despite the fact that this package maintains support for legacy versions, as some of the developer tools require newer functionality to work (e.g. type annotation format introduced in python 3.10).
In order to contribute, you will need to [install the module from source](/INSTALL.md#installation-from-source) with developer dependencies (i.e. `dev` bundle) and, optionally, in editable mode. We recommend using the latest version of python available despite the fact that this software maintains support for legacy versions, as some of the developer tools require newer functionality to work (e.g. type annotation format introduced in python 3.10).

If you do not have write permissions to the original repository, you will need to open a fork in your personal account first, and submit all pull requests (PR) from there. Even if you have write permissions, forking the repository should always work provided that this functionality is enabled, so this is the recommended approach.

Expand Down
12 changes: 6 additions & 6 deletions FILEMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Guidelines

- [`CITATION.bib`](CITATION.bib) --
BibTeX file including the bibliographic reference to cite the software package.
BibTeX file including the bibliographic reference to cite the software.
- [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) --
participation in the repository is subject to these conduct guidelines.
- [`CONTRIBUTING.md`](CONTRIBUTING.md) --
Expand All @@ -13,19 +13,19 @@
- [`FILEMAP.md`](FILEMAP.md) --
a summary of the repository structure and explanations of the different files and folders.
- [`INSTALL.md`](INSTALL.md) --
guidelines to install the software package contained in this repo.
guidelines to install the software contained in this repo.
- [`LICENSE.txt`](LICENSE.txt) --
one of the [standard legal requirements](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) for an open source project. There are different types of [licenses for software](https://en.wikipedia.org/wiki/Software_license), some of the most popular being [open source](https://opensource.org/licenses).
- [`README.md`](README.md) --
main readme for repository.


## Software package
## Software package/library

- `<pyproject_qiskit>` --
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 <pyproject_qiskit> import __version__`).
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. This name will determine how the software is imported after installation (e.g. `from <pyproject_qiskit> import __version__`).
- [`CHANGELOG.md`](CHANGELOG.md) --
file that logs all the changes made to the software package on each new version release.
file that logs all the changes made to the software on each new version release.
- [`docs`](docs) --
documentation for the repository (e.g. tutorials, API docs, reference guide).
- [`test`](test) --
Expand Down Expand Up @@ -95,6 +95,6 @@
- [`.pylintrc`](.pylintrc) --
configuration for [Pylint](https://pylint.readthedocs.io/), a tool for static code analysis (e.g. lint errors).
- [`pytest.ini`](pytest.ini) --
configuration for the [PyTest framework](https://pytest.org) used for testing the software package.
configuration for the [PyTest framework](https://pytest.org) used for testing the software.
- [`tox.ini`](tox.ini) --
configuration file for [tox](https://tox.readthedocs.io/en/latest/) framework that aims to automate and standardize testing in Python. Eases the packaging, testing and release process of Python software.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

## About this Project

This template repository is a tool for creating [Qiskit](https://www.ibm.com/quantum/qiskit)-based Python projects quickly. It provides much of the necessary boilerplate code and configurations needed for a fully functional, professional, software package.
This template repository is a tool for creating [Qiskit](https://www.ibm.com/quantum/qiskit)-based Python projects quickly. It provides much of the necessary boilerplate code and configurations needed for a fully functional, professional, software.

It was originally put together for quick development of _Quantum Software Prototypes_: collaborations between developers and researchers to bring users early access to solutions from cutting-edge research.

Expand All @@ -70,7 +70,7 @@ Check out the [file map](FILEMAP.md) for more information on the structure of th

## Installation

The latest version of this software package can be easily installed, alongside all required dependencies, via `pip`:
The latest version of this software can be easily installed, alongside all required dependencies, via `pip`:
```
pip install pyproject-qiskit@git+https://github.com/pedrorrivero/pyproject-qiskit
```
Expand All @@ -91,7 +91,7 @@ For more detailed information and alternative installation options see the [inst

## Deprecation Policy

This package is meant to evolve rapidly and, as such, does not follow [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md).
This software is meant to evolve rapidly and, as such, does not follow [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md).

We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in [`CHANGELOG.md`](CHANGELOG.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/reference_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Reference guide

This guide is for those who just want to use the package. If you want to extend the module or documentation, read [this other guide](/CONTRIBUTING.md) instead. See here for [installation instructions](/INSTALL.md).
This guide is for those who just want to use the software. If you want to extend the module or documentation, read [this other guide](/CONTRIBUTING.md) instead. See here for [installation instructions](/INSTALL.md).


## Table of contents
Expand Down Expand Up @@ -34,4 +34,4 @@ This guide is for those who just want to use the package. If you want to extend

## Troubleshooting

If you run into problems while using this package, we encourage a careful reading of the error messages first. Efforts have been made to make this messages as descriptive and helpful as possible; nonetheless, if still unable to solve the problem, you are welcome to [open an issue](https://github.com/pedrorrivero/pyproject-qiskit/issues) on the GitHub repository. When doing so, please provide a detailed explanation of what is happening and what needs to be done to reproduce the faulty behavior.
If you run into problems while using this software, we encourage a careful reading of the error messages first. Efforts have been made to make this messages as descriptive and helpful as possible; nonetheless, if still unable to solve the problem, you are welcome to [open an issue](https://github.com/pedrorrivero/pyproject-qiskit/issues) on the GitHub repository. When doing so, please provide a detailed explanation of what is happening and what needs to be done to reproduce the faulty behavior.

0 comments on commit f902b88

Please sign in to comment.