Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ScribeMD/.github

GitHub Actions Starter Workflows and Default Community Health Files
https://github.com/ScribeMD/.github

asdf community-health-files conventional-commits editorconfig github github-actions markdown megalinter nodejs pre-commit prettier python python-poetry renovate semver starter-workflows vscode yaml

Last synced: 6 days ago
JSON representation

GitHub Actions Starter Workflows and Default Community Health Files

Host: GitHub
URL: https://github.com/ScribeMD/.github
Owner: ScribeMD
License: mit
Created: 2022-05-04T06:37:09.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-03-26T01:35:19.000Z (8 months ago)
Last Synced: 2024-08-01T15:29:38.888Z (3 months ago)
Topics: asdf, community-health-files, conventional-commits, editorconfig, github, github-actions, markdown, megalinter, nodejs, pre-commit, prettier, python, python-poetry, renovate, semver, starter-workflows, vscode, yaml
Homepage:
Size: 281 KB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # .github

[![GitHub Community Health Files](https://img.shields.io/badge/GitHub-Community_Health_Files-E6AF2E?logo=github&logoColor=181717&labelColor=343B42)](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)

[![Test Workflow Status](https://github.com/ScribeMD/.github/workflows/Test/badge.svg)](https://github.com/ScribeMD/.github/actions/workflows/test.yaml)

[![Copy/Paste: 0%](https://img.shields.io/badge/Copy%2FPaste-0%25-B200B2?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik03LjAyNCAzLjc1YzAtLjk2Ni43ODQtMS43NSAxLjc1LTEuNzVIMjAuMjVjLjk2NiAwIDEuNzUuNzg0IDEuNzUgMS43NXYxMS40OThhMS43NSAxLjc1IDAgMDEtMS43NSAxLjc1SDguNzc0YTEuNzUgMS43NSAwIDAxLTEuNzUtMS43NVYzLjc1em0xLjc1LS4yNWEuMjUuMjUgMCAwMC0uMjUuMjV2MTEuNDk4YzAgLjEzOS4xMTIuMjUuMjUuMjVIMjAuMjVhLjI1LjI1IDAgMDAuMjUtLjI1VjMuNzVhLjI1LjI1IDAgMDAtLjI1LS4yNUg4Ljc3NHoiLz48cGF0aCBkPSJNMS45OTUgMTAuNzQ5YTEuNzUgMS43NSAwIDAxMS43NS0xLjc1MUg1LjI1YS43NS43NSAwIDExMCAxLjVIMy43NDVhLjI1LjI1IDAgMDAtLjI1LjI1TDMuNSAyMC4yNWMwIC4xMzguMTExLjI1LjI1LjI1aDkuNWEuMjUuMjUgMCAwMC4yNS0uMjV2LTEuNTFhLjc1Ljc1IDAgMTExLjUgMHYxLjUxQTEuNzUgMS43NSAwIDAxMTMuMjUgMjJoLTkuNUExLjc1IDEuNzUgMCAwMTIgMjAuMjVsLS4wMDUtOS41MDF6Ii8+PC9zdmc+&labelColor=343B42)](https://github.com/kucherenko/jscpd)

[![Automated Updates: Renovate](https://img.shields.io/badge/Renovate-Automated_Updates-FF9F1C?logo=renovatebot&logoColor=1A1F6C&labelColor=666)](https://docs.renovatebot.com/)

[![Package Management: Poetry](https://img.shields.io/badge/Poetry-Package_Management-06BA63?logo=poetry&logoColor=60A5FA&labelColor=666)](https://python-poetry.org/)

[![Git Hooks: pre-commit](https://img.shields.io/badge/pre--commit-Git_Hooks-04E762?logo=precommit&logoColor=FAB040&labelColor=666)](https://pre-commit.com/)

[![Commit Style: Conventional Commits](https://img.shields.io/badge/Conventional_Commits-Commit_Style-090C9B?logo=conventionalcommits&logoColor=FE5196&labelColor=666)](https://conventionalcommits.org)

[![Releases: Semantic Versioning](https://img.shields.io/badge/SemVer-Releases-08A045?logo=semver&logoColor=3F4551&labelColor=666)](https://semver.org/)

[![Code Style: Prettier](https://img.shields.io/badge/Prettier-Code_Style-000?logo=prettier&logoColor=F7B93E&labelColor=666)](https://prettier.io/)

[![Code Style: EditorConfig](https://img.shields.io/badge/EditorConfig-Code_Style-FF69EB?logo=editorconfig&logoColor=FEFEFE&labelColor=666)](https://editorconfig.org/)

[![Editor: Visual Studio Code](https://img.shields.io/badge/VSCode-Editor-EE8434?logo=visualstudiocode&logoColor=007ACC&labelColor=666)](https://code.visualstudio.com/)

- [.github](#github)

  - [Usage](#usage)

    - [To use GitHub Actions workflows](#to-use-github-actions-workflows)

    - [To use community health files](#to-use-community-health-files)

  - [Contributing](#contributing)

  - [Changelog](#changelog)

GitHub Actions Starter Workflows and Default Community Health Files for ScribeMD

## Usage

### To use GitHub Actions workflows

- To use

  [starter workflows](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization),

  please refer to

  [using starter workflows](https://docs.github.com/en/actions/using-workflows/using-starter-workflows).

  We use [Octicons](https://primer.github.io/octicons/) v17.0.0 for their icons.

### To use community health files

- GitHub automatically uses the

  [default community health files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)

  housed here in [ScribeMD repositories](https://github.com/ScribeMD/).

- If you already have copies of the desired files, they will override the

  defaults found here unless deleted.

- The repository must be housed within

  [the ScribeMD organization](https://github.com/ScribeMD/). If it is not, you

  will need either to

  [transfer ownership](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository)

  or copy the desired files to your repository. In the latter case, changes will

  not propagate automatically.

## Contributing

Please refer to [`CONTRIBUTING.md`](CONTRIBUTING.md).

## Changelog

Please refer to [`CHANGELOG.md`](CHANGELOG.md).