Skip to content

Commit ca6e9dc

Browse files
authored
🎾 [readme] remove template-repo debris for a clean start (#1)
1 parent 9101210 commit ca6e9dc

File tree

2 files changed

+6
-105
lines changed

2 files changed

+6
-105
lines changed

README.md

Lines changed: 6 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,11 @@
1-
# FINI template-repo
1+
# fini-clock
22

3-
![GitHub Issues](https://img.shields.io/github/issues/fini-net/template-repo)
4-
![GitHub Pull Requests](https://img.shields.io/github/issues-pr/fini-net/template-repo)
5-
![GitHub License](https://img.shields.io/github/license/fini-net/template-repo)
6-
![GitHub watchers](https://img.shields.io/github/watchers/fini-net/template-repo)
3+
![GitHub Issues](https://img.shields.io/github/issues/fini-net/fini-clock)
4+
![GitHub Pull Requests](https://img.shields.io/github/issues-pr/fini-net/fini-clock)
5+
![GitHub License](https://img.shields.io/github/license/fini-net/fini-clock)
6+
![GitHub watchers](https://img.shields.io/github/watchers/fini-net/fini-clock)
77

8-
A good template for github repos with best practices adoption.
9-
10-
## Template Features
11-
12-
-[All github community standards are checked off](https://github.com/fini-net/template-repo/community)
13-
- ✅ This [README](README) with badges
14-
-[Contributor Covenant](https://www.contributor-covenant.org)-based Code of Conduct
15-
-[Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our
16-
[command line development process](.github/CONTRIBUTING.md#development-process).
17-
-[GPL2](LICENSE) license
18-
-[Security Policy](.github/SECURITY.md)
19-
-[Issue Templates](.github/ISSUE_TEMPLATE/)
20-
-[PR Template](.github/pull_request_template.md)
21-
-[gitattributes](.gitattributes) based on [gitattributes](https://github.com/gitattributes/gitattributes)
22-
-[gitignore](.gitignore) with comments
23-
-[CODEOWNERS](.github/CODEOWNERS) that is self-documented
24-
-[justfile](justfile) with
25-
[command line workflow for pull requests](.github/CONTRIBUTING.md#development-process)
26-
-[Github Actions](.github/workflows) are already setup for:
27-
-[Auto-assign](https://github.com/pozil/auto-assign-issue) helps avoid toil.
28-
-[Checkov](https://github.com/bridgecrewio/checkov) will help keep our github actions secure
29-
-[Markdownlint](https://github.com/DavidAnson/markdownlint-cli2-action) keeps your READMEs standards-compliant
30-
-[A few extra labels for issues](https://github.com/fini-net/template-repo/labels)
31-
32-
## Usage
33-
34-
1. To use this template, you can create a new repository by clicking on "Use this
35-
template" button.
36-
1. Remember to replace any `chicks-net`, `fini-net`, and `template-repo` references
37-
with the right values for your project. (Github templates do not offer
38-
variable substitution, but we still have to call them templates for some reason.)
39-
1. Ditch the "Template Status", "Usage", and "Kudos" sections in the `README.md`.
40-
`just clean-readme` will give you a clean README, but there are other files to fix.
41-
42-
[Here is a nice checklist](https://github.com/jlcanovas/gh-best-practices-template/blob/main/guidelines.md)
43-
of things to consider with a new repo.
8+
Clock for mobile and open platforms.
449

4510
## Contributing
4611

@@ -52,27 +17,3 @@ of things to consider with a new repo.
5217

5318
- [Getting Support](.github/SUPPORT.md)
5419
- [Security Policy](.github/SECURITY.md)
55-
56-
## License
57-
58-
I went with the [GPL2 license](LICENSE), but the MIT license is also worth considering.
59-
60-
## Other good template repos on github
61-
62-
- Jose Gracia Berenguer did a great job with their
63-
[project-template](https://github.com/Josee9988/project-template)
64-
repo. This looks like a student project, but it is one of the best
65-
templates I've found on github.
66-
- [Cookiecutter Data Science](https://github.com/drivendataorg/cookiecutter-data-science)
67-
is cool, but it isn't actually a template repo.
68-
- [gh-best-practices-template](https://github.com/jlcanovas/gh-best-practices-template)
69-
is doing great at checking off all of the boxes. They've including funding and citations
70-
which I haven't tried yet. I'm not a fan of how all of the Markdown files are in the
71-
root directory. I definitely prefer stuffing those under `/.github` for a cleaner
72-
root directory.
73-
74-
## Thanks
75-
76-
- I've really enjoyed building projects with [just](https://just.systems/man/en/).
77-
- The [GitHub CLI](https://cli.github.com/) makes browser-free workflows not only
78-
possible, but fun.

justfile

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,3 @@ import? '.just/shellcheck.just'
1010
list:
1111
just --list
1212
@echo "{{GREEN}}Your justfile is waiting for more scripts and snippets{{NORMAL}}"
13-
14-
# generate a clean README
15-
[group('Utility')]
16-
[no-cd]
17-
clean_readme: _on_a_branch
18-
#!/usr/bin/env bash
19-
set -euo pipefail # strict mode without tracing
20-
21-
GIT_ORIGIN=$(git config --get remote.origin.url | sed -e 's/^.*://' -e 's/[.]git$//')
22-
#echo "$GIT_ORIGIN"
23-
24-
GITHUB_ORG=$(echo "$GIT_ORIGIN" | sed -e 's/[/].*$//')
25-
echo "org={{BLUE}}$GITHUB_ORG{{NORMAL}}"
26-
27-
GITHUB_REPO=$(echo "$GIT_ORIGIN" | sed -e 's/^.*[/]//')
28-
echo "repo={{BLUE}}$GITHUB_REPO{{NORMAL}}"
29-
30-
cat > README.md << END_OF_HEREDOC
31-
# ${GITHUB_REPO}
32-
33-
![GitHub Issues](https://img.shields.io/github/issues/${GITHUB_ORG}/${GITHUB_REPO})
34-
![GitHub Pull Requests](https://img.shields.io/github/issues-pr/${GITHUB_ORG}/${GITHUB_REPO})
35-
![GitHub License](https://img.shields.io/github/license/${GITHUB_ORG}/${GITHUB_REPO})
36-
![GitHub watchers](https://img.shields.io/github/watchers/${GITHUB_ORG}/${GITHUB_REPO})
37-
38-
A good starting place for something. (TODO)
39-
40-
## Contributing
41-
42-
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)
43-
- [Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our
44-
[development process](.github/CONTRIBUTING.md#development-process).
45-
46-
## Support & Security
47-
48-
- [Getting Support](.github/SUPPORT.md)
49-
- [Security Policy](.github/SECURITY.md)
50-
END_OF_HEREDOC
51-
52-
echo "{{BLUE}}You can remove the clean_readme recipe from /justfile also.{{NORMAL}}"

0 commit comments

Comments
 (0)