Skip to content

Commit

Permalink
Merge pull request #10 from noclocks/develop
Browse files Browse the repository at this point in the history
Develop -> Main
  • Loading branch information
jimbrig authored Mar 17, 2024
2 parents a73e6cd + 1f7fe0b commit cf72cdd
Show file tree
Hide file tree
Showing 11 changed files with 169 additions and 11 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
changelog:
name: Generate changelog
name: Generate Changelog
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand All @@ -26,13 +25,13 @@ jobs:
id: print-changelog
run: |
cat "CHANGELOG.md"
- name: Commit and Push
id: commit-push
# Commit and push the updated changelog, IF not a pull request
- name: Commit and Push Changelog
if: github.event_name != 'pull_request'
run: |
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
set +e
git add CHANGELOG.md
git commit -m "[chore]: update changelog"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git "main"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git "main"
41 changes: 41 additions & 0 deletions FUNDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# No Clocks, LLC Funding

*Last Updated: **`2024-03-17`***

## Funding

[No Clocks, LLC](https://github.com/noclocks) is an open-source development team that relies on the support of the community to maintain and improve our projects. If you find value in our work, please consider supporting us financially. Your contributions will help us continue to produce high-quality software and provide support to our users.

No Clocks approaches funding with the following principles:

- **Transparency**: We will be transparent about how we use the funds we receive. Everyone gets to see where the money goes and where it came from.

- **Open Participation**: We will make it easy for anyone to contribute to our projects. We will provide multiple ways for people to support us financially.

- **Sustainability**: We will use the funds to ensure the long-term sustainability of our projects.

- **Community Support**: We will use the funds to support the community that supports us. We will use the funds to support the people who contribute to our projects.

- **No Strings Attached**: We will not accept funding that comes with strings attached. We will not accept funding that requires us to change our projects or our principles.

- **No Advertising**: We will not use the funds to advertise our projects. We will not use the funds to promote our projects.

- **No Profit**: We will not use the funds to make a profit. We will use the funds to cover the costs of maintaining and improving our projects.

## Distribution

The funds we receive will be invested back into the community. Every dollar spent should suport or improve a project, or the community that supports us.

- **Merchandise**: Creating and distributing merchandise to our contributors and supporters.

- **Documentation**: Creating and maintaining documentation for our projects.

- **Website**: Maintaining and improving our website.

- **Infrastructure**: Maintaining and improving the infrastructure that supports our projects.

- **Research**: Funding research that supports our projects.

- **Supporting Contributors**: Supporting the people who contribute to our projects.

- **Sponsoring Other Projects**: Supporting other open-source projects that we rely on.
24 changes: 24 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Governance

> [!NOTE]
> This document outlines the governance model for the [No Clocks, LLC](https://github.com/noclocks) open-source development team. It includes detailed descriptions of the roles and responsibilities of the team members, as well as the decision-making process and the rules for the team's operations.
- **All members of the team are expected to adhere to the rules and guidelines outlined in this document as well as the organization's [Code of Conduct (CoC)](./CODE_OF_CONDUCT.md).**

## Contribution

> [!NOTE]
> [No Clocks, LLC](https://github.com/noclocks) strives to be an open and inclusive community. We welcome contributions from everyone, regardless of their experience and want to recognize that everyone's contributions are valuable.
- **All contributions to the organization's open-source projects are subject to the rules and guidelines outlined in the [Contributing Guidelines](./CONTRIBUTING.md).**

## Roles and Responsibilities

We recognize different levels of contribution as four different Contributor Levels. Because each level comes with a new set of privileges and responsibilities, you may also see these levels referred to as Contributor Roles.

Contributor levels are available to all members of the Astro community, regardless of coding skill or experience.

Two important things that we look for in a contributor are:

Being here - Everyone's time is valuable, and the fact that you're here and contributing to Astro is amazing! Thank you for being a part of this project with us.
Being a positive member of our community - Go above and beyond our Code of Conduct and commit to healthy communication across pull requests, issue discussions, Discord conversations, and any interactions outside of our community
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
14 changes: 14 additions & 0 deletions SECURITY_CONTACTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Defined below are the security contacts for this repo.
#
# They are the contact point for triaging and handling of incoming
# Security issues.
#
# The below names agree to abide by the
# [Embargo Policy](https://github.com/withastro/.github/blob/main/SECURITY.md)
# and will be removed and replaced if they violate that agreement.
#
# DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE
# INSTRUCTIONS AT https://github.com/noclocks/.github/blob/main/SECURITY.md

Jimmy Briggs (@jimbrig)
Patrick Howard (@phoward38)
Empty file added docs/about.md
Empty file.
22 changes: 22 additions & 0 deletions docs/checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# GitHub Checklist

- [ ] Create GitHub Organization: `noclocks`
- [ ] Set Organization Owners
- [ ] Set Organization Members
- [ ] Set Organization Teams
- [ ] Set Organization Projects
- [ ] Set Organization Repositories
- [ ] Set Organization Settings
- [ ] Set Organization Billing
- [ ] Initialize Repository: `noclocks/.github`
- [ ] Create Organization Public Profile README ([`noclocks/.github/profile/README.md`](htps://github.com/noclocks/.github/profile/README.md))
- [ ] Customize Private Organization Profile README ([`noclocks/.github-private/profile/README.md`](htps://github.com/noclocks/.github-private/profile/README.md))


- [ ] Add `CODE_OF_CONDUCT.md`
- [ ] Add `CONTRIBUTING.md`
- [ ] Add `FUNDING.yml`
- [ ] Add `GOVERNANCE.md`
- [ ] Add `SECURITY.md`
- [ ] Add `SUPPORT.md`
- [ ] Add `.github/ISSUE_TEMPLATES`
Empty file added docs/index.md
Empty file.
File renamed without changes.
File renamed without changes.
7 changes: 4 additions & 3 deletions workflow-templates/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,13 @@ jobs:
id: print-changelog
run: |
cat "CHANGELOG.md"
- name: Commit and Push
id: commit-push
# Commit and push the updated changelog, IF not a pull request
- name: Commit and Push Changelog
if: github.event_name != 'pull_request'
run: |
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
set +e
git add CHANGELOG.md
git commit -m "[chore]: update changelog"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git $default-branch
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git "main"

0 comments on commit cf72cdd

Please sign in to comment.