https://github.com/timo-reymann/project-partials
Partial files for projects to copy&pasta and adjust
https://github.com/timo-reymann/project-partials
markdown partials
Last synced: about 1 year ago
JSON representation
Partial files for projects to copy&pasta and adjust
- Host: GitHub
- URL: https://github.com/timo-reymann/project-partials
- Owner: timo-reymann
- License: unlicense
- Created: 2023-02-18T15:35:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T17:30:15.000Z (over 2 years ago)
- Last Synced: 2025-03-05T08:36:48.423Z (over 1 year ago)
- Topics: markdown, partials
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
project-partials
===
[](https://github.com/timo-reymann/project-partials/blob/main/LICENSE)
Partial files for projects to copy&pasta and adjust
## Usage
### Contribution guidelines
#### Contribution guidelines for projects using CircleCI
- [Template](./partials/CONTRIBUTING.circleci.md)
- Templating:
```bash
export PROJECT_NAME=Human project name
export LICENSE_NAME=license name
export REPO_SLUG_NAME=repo-name-github
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/CONTRIBUTING.circleci.md | envsubst
```
#### Contribution guidelines for projects using GitHub Actions
- [Template](./partials/CONTRIBUTING.github-actions.md)
- Templating:
```bash
export PROJECT_NAME=Human project name
export LICENSE_NAME=license name
export REPO_SLUG_NAME=repo-name-github
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/CONTRIBUTING.github-actions.md | envsubst
```
#### Contribution guidelines for projects using no pipeline
- [Template](./partials/CONTRIBUTING.no-pipeline.md)
- Templating:
```bash
export PROJECT_NAME=Human project name
export LICENSE_NAME=license name
export REPO_SLUG_NAME=repo-name-github
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/CONTRIBUTING.no-pipeline.md | envsubst
```
### READMEs
#### README with Circleci or GitHub Workflow
- [Template](./partials/README.general.md)
- Templating:
```bash
export PROJECT_NAME=Human project name
export REPO_SLUG_NAME=repo-name-github
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/README.general.md | envsubst
```
#### README for GitHub Action
- [Template](./partials/README.github-action.md)
- Templating:
```bash
export PROJECT_NAME=my-action
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/README.github-action.md | envsubst
```
#### README for Slides
- [Template](./partials/README.slides.md)
- Templating:
```bash
export PROJECT_NAME=my-action
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/README.slides.md | envsubst
```
#### README for Homebrew formulas
- [Template](./partials/README.homebrew.md)
- Templating:
```bash
export PROJECT_NAME=my-source-project
curl -sS https://raw.githubusercontent.com/timo-reymann/project-partials/main/partials/README.homebrew.md | envsubst
```