diff --git a/.copier-answers.yml b/.copier-answers.yml index 2059336..fde9161 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -6,7 +6,7 @@ # available at https://github.com/gt-sse-center/copier-ProjectScaffolding. # -_commit: v0.2.9 +_commit: v0.2.10 _src_path: https://github.com/gt-sse-center/copier-ProjectScaffolding author_email: github@DavidBrownell.com author_name: David Brownell diff --git a/.gitignore b/.gitignore index 8e9d6c0..63b5e18 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +1,19 @@ post_generation_actions.html - -Activate*.cmd -Activate*.sh -Deactivate*.cmd -Deactivate*.sh - -**/__pycache__/** -**/Generated/** - -**/.coverage -**/lcov.info -**/.vscode - -build/** -dist/** -src/FileBackup.egg-info/** - -minisign_key.pri + +Activate*.cmd +Activate*.sh +Deactivate*.cmd +Deactivate*.sh + +**/__pycache__/** +**/Generated/** + +**/.coverage +**/lcov.info +**/.vscode + +build/** +dist/** +src/FileBackup.egg-info/** + +minisign_key.pri diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f87c3a8..6390d77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,17 +12,23 @@ Examples of unacceptable behavior by participants include the use of sexual lang Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the [project maintainers](MAINTAINERS.md). ## General information + For specific proposals, please provide them as [pull requests](https://github.com/coreinfrastructure/best-practices-badge/pulls) or [issues](https://github.com/coreinfrastructure/best-practices-badge/issues) via our [GitHub site](https://github.com/davidbrownell/FileBackup). + The [DEVELOPMENT.md](DEVELOPMENT.md) file explains how to install the program locally (highly recommended if you're going to make code changes). It also provides information useful for making changes and validating them locally before submitting a pull request. ### Pull requests and different branches recommended + Pull requests are preferred, since they are specific. For more about how to create a pull request, see https://help.github.com/articles/using-pull-requests/. We recommend creating different branches for different (logical) changes, and creating a pull request into the `main` branch when you're done. See the GitHub documentation on [creating branches](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) and [using pull requests](https://help.github.com/articles/using-pull-requests/). + ### How we handle proposals + We use GitHub to track proposed changes via its [issue tracker](https://github.com/coreinfrastructure/best-practices-badge/issues) and [pull requests](https://github.com/coreinfrastructure/best-practices-badge/pulls). Specific changes are proposed using those mechanisms. Issues are assigned to an individual, who works and then marks it complete. If there are questions or objections, the conversation of that issue or pull request is used to resolve it. + ### We are proactive In general we try to be proactive to detect and eliminate mistakes and vulnerabilities as soon as possible, and to reduce their impact when they do happen. We use a defensive design and coding style to reduce the likelihood of mistakes, a variety of tools that try to detect mistakes early, and an automatic test suite with significant coverage. We also release the software as open source software so others can review it. diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index aacceaa..cfaf723 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,6 +1,7 @@ # Local Development ## Enlistment + Enlistment in this repository involves these steps. @@ -68,8 +69,10 @@ Enlistment in this repository involves these steps.
+ ## Development Activities + Each of these activities can be invoked from an activated terminal on your local machine. | Activity | Command Line | Description | Invoked by Continuous Integration | @@ -82,3 +85,4 @@ Each of these activities can be invoked from an activated terminal on your local | Python Package Publishing |

python Build.py publish

Requires that the repository was bootstrapped with the --package flag. | Publish a python package to [PyPi](https://pypi.org). | :white_check_mark: | | Build Binaries | `python Build.py build_binaries` | Create a python binary for your current operating system using [cx_Freeze](https://cx-freeze.readthedocs.io/) based on settings in `src/BuildBinary.py`. | :white_check_mark: | | Development Docker Image | `python Build.py create_docker_image` | Create a [docker](https://docker.com) image for a bootstrapped development environment. This functionality is useful when adhering to the [FAIR principles for research software](https://doi.org/10.1038/s41597-022-01710-x) by supporting the creation of a development environment and its dependencies as they existed at the moment when the image was created. | :white_check_mark: | + diff --git a/README.md b/README.md index b51120f..0b99da7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # FileBackup + [![License](https://img.shields.io/github/license/davidbrownell/FileBackup?color=dark-green)](https://github.com/davidbrownell/FileBackup/blob/master/LICENSE.txt) [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/davidbrownell/FileBackup?color=dark-green)](https://github.com/davidbrownell/FileBackup/commits/main/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/FileBackup?color=dark-green)](https://pypi.org/project/FileBackup/) @@ -8,6 +9,7 @@ [![PyPI - Downloads](https://img.shields.io/pypi/dm/filebackup)](https://pypistats.org/packages/filebackup) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9069/badge)](https://www.bestpractices.dev/projects/9069) [![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/davidbrownell/f15146b1b8fdc0a5d45ac0eb786a84f7/raw/FileBackup_coverage.json)](https://github.com/davidbrownell/FileBackup/actions) + Tool for creating and restoring file system backups. @@ -29,6 +31,7 @@ TODO: Complete this section ## Installation + FileBackup can be installed via one of these methods: - [Installation via Executable](#installation-via-executable) @@ -54,9 +57,12 @@ To install the FileBackup package via [pip](https://pip.pypa.io/en/stable/) (Pyt `pip install FileBackup` + ## Development -Please visit [Contributing](https://github.com/davidbrownell/FileBackup/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/FileBackup/blob/main/DEVELOPMENT.md) for information on contributing to this project. + +Please visit [Contributing](https://github.com/davidbrownell/FileBackup/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/FileBackup/blob/main/DEVELOPMENT.md) for information on contributing to this project. + ## Additional Information @@ -64,12 +70,14 @@ Additional information can be found at these locations. | Title | Document | Description | | --- | --- | --- | + | Code of Conduct | [CODE_OF_CONDUCT.md](https://github.com/davidbrownell/FileBackup/blob/main/CODE_OF_CONDUCT.md) | Information about the the norms, rules, and responsibilities we adhere to when participating in this open source community. | | Contributing | [CONTRIBUTING.md](https://github.com/davidbrownell/FileBackup/blob/main/CONTRIBUTING.md) | Information about contributing code changes to this project. | | Development | [DEVELOPMENT.md](https://github.com/davidbrownell/FileBackup/blob/main/DEVELOPMENT.md) | Information about development activities involved in making changes to this project. | | Governance | [GOVERNANCE.md](https://github.com/davidbrownell/FileBackup/blob/main/GOVERNANCE.md) | Information about how this project is governed. | | Maintainers | [MAINTAINERS.md](https://github.com/davidbrownell/FileBackup/blob/main/MAINTAINERS.md) | Information about individuals who maintain this project. | | Security | [SECURITY.md](https://github.com/davidbrownell/FileBackup/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. | + ## License diff --git a/SECURITY.md b/SECURITY.md index 87fc639..475f459 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,9 @@ If you find a significant vulnerability, or evidence of one, please report it privately. + We prefer that you use the [GitHub mechanism for privately reporting a vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability). Under the [main repository's security tab](https://github.com/davidbrownell/FileBackup/security), in the left sidebar, under "Reporting", click "Advisories", click the "New draft security advisory" button to open the advisory form. + We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes.