Skip to content

Commit

Permalink
docs: update and enhance README
Browse files Browse the repository at this point in the history
  • Loading branch information
jimbrig committed Mar 17, 2024
1 parent 2b4edab commit 3bfca5a
Showing 1 changed file with 59 additions and 2 deletions.
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,71 @@
# No Clocks, LLC <img src="assets/img/logo/main-logo-white-transparent.png" width="15%" align="right">

> [!NOTE]
> [No Clocks, LLC](https://noclocks.dev) is a new, cutting-edge, technology-based agency startup that seamlessly blends the expertise of seasoned Software Engineers, Web Developers, and Data Engineers.
> *Default [Community Health Files](https://help.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file) for all of [No Clocks, LLC](https://github.com/noclocks) open-source projects.*
*Default [Community Health Files](https://help.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file) for all of No Clocks' open-source projects.*
[No Clocks, LLC](https://noclocks.dev) is a new, cutting-edge, technology-based agency startup that seamlessly blends the expertise of seasoned Software Engineers, Web Developers, and Data Engineers.

## Badges

<!-- BADGES:Start -->

[![Automate Changelog](https://github.com/noclocks/.github/actions/workflows/changelog.yml/badge.svg)](https://github.com/noclocks/.github/actions/workflows/changelog.yml)

<!-- BADGES:End -->

## Overview

This repository contains the default [Community Health Files](https://help.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file) for all of [No Clocks, LLC](https://github.com/noclocks) open-source projects.

These files are used to provide a consistent experience across all of our projects, and to make it easier for contributors to understand how to contribute to our projects.

## About

Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. You can add default community health files to a public repository called .github, in the root of the repository or in the docs or .github folders. These files help you automate and standardize various aspects of your project's development and community interaction. They are essential for promoting transparency, good practices, and collaboration in open source projects.

GitHub will use and display default files for any repository owned by the account that does not have its own file of that type in any of the following places:

- The repository root
- The [`.github`](./.github/) folder
- The [`docs`](./docs/) folder

For example, if you have a repository with no `CONTRIBUTING` file, GitHub will use the default `CONTRIBUTING` file from here. If you create a custom `CONTRIBUTING` file in the repository, GitHub will use that file instead of the default file.

> [!WARNING]
> If a repository has any files in its own [`.github/ISSUE_TEMPLATE`](./.github/ISSUE_TEMPLATES/) folder, including issue templates or a `config.yml` file, none of the contents of the default [`.github/ISSUE_TEMPLATES](./.github/ISSUE_TEMPLATES/) folder will be used.
As a repository maintainer, you can use the community standards checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see [About community profiles for public repositories](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).

## Supported Files

This repository contains the following default community health files:

| File | Description |
|:----------------------------------------------------------------------------------------------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) | `CODE_OF_CONDUCT` files define standards for how to engage in a community. |
| [CONTRIBUTING.md](./CONTRIBUTING.md) | `CONTRIBUTING` files communicate how people should contribute to your project. |
| Discussion Category Forms | Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. |
| [FUNDING.yml](./FUNDING.yml) | `FUNDING` files display a sponsor button in the repository to increase the visibility of funding options for an open source project. |
| [GOVERNANCE.md](./GOVERNANCE.md) | A `GOVERNANCE` file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. |
| [Issue](./.github/ISSUE_TEMPLATES/) and [Pull Request](./.github/PULL_REQUEST_TEMPLATE.md) Templates | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. |
| [SECURITY.md](./SECURITY.md) | `SECURITY` files provide instructions for how to report a vulnerability in a project. |
| [SUPPORT.md](./SUPPORT.md) | `SUPPORT` files let people know about how to get support for a project. |



## Community Health Files

- [Code of Conduct](./CODE_OF_CONDUCT.md): Our Code of Conduct.
- [Contributing Guidelines](./CONTRIBUTING.md): How to contribute to our projects.
- [Issue](./.github/ISSUE_TEMPLATES/) and [Pull Request](./.github/PULL_REQUEST_TEMPLATE.md) Templates: Templates for Issues and Pull Requests.
- [Security Policy](./SECURITY.md): How to report security vulnerabilities.
- [Support](./SUPPORT.md): How to get support for our projects.
- [Funding](./FUNDING.yml): How to support our projects financially.
- [License](./LICENSE): Our Default License: [Unlicense](https://unlicense.org/).




## GitHub Workflow Templates

- [Changelog Workflow](./workflow-templates/changelog.yml): Default Changelog Automation Workflow with `git-cliff`.
Expand Down

0 comments on commit 3bfca5a

Please sign in to comment.