Skip to content

Commit face0b1

Browse files
committed
Refine README.md for clarity and consistency in file descriptions
1 parent 5a32c40 commit face0b1

File tree

1 file changed

+26
-30
lines changed

1 file changed

+26
-30
lines changed

README.md

+26-30
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,28 @@
11
# Elevated Standards Python Repository Template
22

3-
This template repository equips you with the default initial files required for a Elevated Standards GitHub Python Repository.
3+
This template repository provides you with the essential initial files needed for an Elevated Standards GitHub Python Repository.
44

55
## Included Files
66

7-
The repository comes with the following preset files:
7+
**The repository comes with the following preset files:**
88

9-
* `.devcontainer`: Folder containing files used for setting up a devcontainer
10-
* `devcontainer.json`: File configuring the devcontainer, includes VS Code settings
11-
* `.github`: Folder for Github-specific files and folders
12-
* `workflows`: Folder containing Github actions config files
13-
* `python.yaml`: File configuring Github action that runs tools and tests
9+
* `.devcontainer`: Directory housing the configuration files for initializing a devcontainer.
10+
* `devcontainer.json`: File that configures the devcontainer, containing settings for VS Code.
11+
* `.github`: Directory dedicated to GitHub-specific files and configurations.
12+
* `actions`: Directory containing custom GitHub Actions scripts or reusable workflows for automation within the repository.
13+
* `workflows`: Directory housing configuration files for GitHub Actions.
14+
* `python.yaml`: File that configures the GitHub Action responsible for executing tools and running tests.
1415
* `tests`: Folder containing Python tests
15-
* `main_test.py`: File with pytest-style tests of main.py
16-
* `.gitignore`: File describing what file patterns Git should never track
17-
* `.pre-commit-config.yaml`: File listing all the pre-commit hooks and args
18-
* `main.py`: The main (and currently only) Python file for the program
19-
* `pyproject.toml`: File configuring most of the Python dev tools
20-
* `README.md`: You're reading it!
21-
* `requirements-dev.txt`: File listing all PyPi packages required for development
22-
* `requirements.txt`: File listing all PyPi packages required for production
23-
* `.github`: Folder for workflows, templates and etc.
24-
* `dependabot.yml`:
25-
* `workfows.yml`:
26-
* `actions`:
27-
* `CODEOWNERS`:
28-
* `LICENSE`:
16+
* `main_test.py`: File containing pytest-style test cases for `main.py`.
17+
* `.gitignore`: File specifying file patterns that Git should ignore and never track.
18+
* `.pre-commit-config.yaml`: File enumerating all pre-commit hooks and their associated arguments.
19+
* `main.py`: The primary (and currently sole) Python file for the program.
20+
* `pyproject.toml`: File that configures the majority of Python development tools.
21+
* `README.md`: This is it.
22+
* `requirements-dev.txt`: File containing a list of all PyPI packages required for development.
23+
* `requirements.txt`: File containing a list of all PyPI packages required for production.
24+
* `CODEOWNERS`: File specifying individuals or teams responsible for maintaining specific parts of the codebase, used for automatic review requests in pull requests.
25+
* `LICENSE`: File outlining the legal terms and conditions under which the software is distributed and used.
2926

3027
## Setup Instructions
3128

@@ -88,13 +85,13 @@ If your repository is private with no GitHub Advanced Security license, remove t
8885
* `ruff`: identifies many errors and style issues (`flake8`, `isort`, `pyupgrade`)
8986
* `black`: auto-formats code
9087

91-
Those checks are run as pre-commit hooks using the `pre-commit` library.
88+
Those checks are executed as `pre-commit` hooks using the pre-commit library.
9289

93-
It includes `pytest` for testing plus the `pytest-cov` plugin to measure coverage.
90+
The setup includes `pytest` for running tests, along with the `pytest-cov` plugin to measure code coverage.
9491

95-
The checks and tests are all run using Github actions on every pull request and merge to main.
92+
All checks and tests are automatically run via GitHub Actions on every pull request and merge into the main branch.
9693

97-
This repository is setup for Python 3.11. To change the version:
94+
This repository is configured for Python 3.11. To switch to a different Python version:
9895

9996
1. Change the `image` argument in `.devcontainer/devcontainer.json` (see [https://github.com/devcontainers/images/tree/main/src/python](https://github.com/devcontainers/images/tree/main/src/python#configuration) for a list of pre-built Docker images)
10097
1. Change the config options in `.precommit-config.yaml`
@@ -103,13 +100,13 @@ This repository is setup for Python 3.11. To change the version:
103100

104101
### With devcontainer
105102

106-
This repository comes with a devcontainer (a Dockerized Python environment). If you open it in Codespaces, it should automatically initialize the devcontainer.
103+
This repository includes a devcontainer, which is a Dockerized Python environment. If you open the repository in GitHub Codespaces, the devcontainer will initialize automatically.
107104

108-
Locally, you can open it in VS Code with the Dev Containers extension installed.
105+
For local development, you can open it in VS Code with the Dev Containers extension installed to set up the environment.
109106

110107
### Without devcontainer
111108

112-
If you can't or don't want to use the devcontainer, then you should first create a virtual environment:
109+
If you are unable or prefer not to use the devcontainer, the first step is to create a virtual environment:
113110

114111
```
115112
python3 -m venv .venv
@@ -125,8 +122,7 @@ pre-commit install
125122

126123
### Adding code and tests
127124

128-
This repository starts with a very simple `main.py` and a test for it at `tests/main_test.py`.
129-
You'll want to replace that with your own code, and you'll probably want to add additional files as your code grows in complexity.
125+
This repository begins with a basic `main.py` file and its corresponding test file located at `tests/main_test.py`. You should replace these with your own code, and as your project evolves, you’ll likely need to add more files to accommodate increasing complexity.
130126

131127
When you're ready to run tests, run:
132128

0 commit comments

Comments
 (0)