Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: set up readme #17

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# .github
# Community health files for the @rdmorganiser organization

*Community health files for the [@rdmorganiser](https://github.com/rdmorganiser) organization*
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![CI Workflow Status](https://github.com/rdmorganiser/.github/actions/workflows/ci.yml/badge.svg)](https://github.com/rdmorganiser/.github/actions/workflows/ci.yml)

For more information, please see the article on [creating a default community health file for your organization](https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization).
Welcome to the Community Health Repository of the [@rdmorganiser](https://github.com/rdmorganiser) organization. This repository serves as the central hub for storing and managing our community health files. These files provide important information about our community's guidelines, best practices, and expectations.

## Purpose
The purpose of this repository is to maintain a centralized location for all community health-related files, making it easier for contributors to find and reference them. This repository is intended to be a living document that evolves alongside our community.

## File Structure

The repository contains the following folders and files:

- [Contributor Guide](https://github.com/rdmorganiser/.github/blob/main/CONTRIBUTING.md): Guidelines for contributing to our organization's projects.
- [Code of Conduct](https://github.com/rdmorganiser/.github/blob/main/CODE_OF_CONDUCT.md): Our code of conduct, outlining expected behavior and standards.
- [Issue Templates](https://github.com/rdmorganiser/.github/tree/main/.github/ISSUE_TEMPLATE): Templates for creating bug reports and feature requests in our organization's projects. These templates help us better understand your request and ensure that we're addressing the right information.
- [Pull Request Template](https://github.com/rdmorganiser/.github/blob/main/.github/PULL_REQUEST_TEMPLATE.md): A template to use when creating a pull request in our organization's projects.

## How to Use

By default, these community health files are applied to all repositories within our organization unless overridden by a specific repository. When creating or contributing to a repository, please review and abide by the guidelines and expectations outlined in this repository.

## Overriding a Central File in a Single Repository

Sometimes, you may need to override a central file for your specific repository. To do so:

1. Create a new file in the root of your repository with the same name as the central file (e.g., `CONTRIBUTING.md`).
2. In this new file, include any changes or additions specific to your repository.
3. Add a note at the top of the file indicating that it overrides the central file (e.g., # This file overrides the central contributing guidelines found in [rdmorganiser/.github](https://github.com/rdmorganiser/.github/blob/main/CONTRIBUTING.md)).

## Contribution Guidelines

Before making changes to any of these files, please review our contributing guidelines in the [Contributor Guide](https://github.com/rdmorganiser/.github/blob/main/CONTRIBUTING.md). This will help ensure that your contributions are properly formatted and aligned with our community's standards.

## License

All content in this repository is licensed under the Apache 2.0 license. By contributing to or using these files, you agree to abide by the terms of this license.

Thank you for participating in our community! If you have any questions or concerns, please don't hesitate to reach out.

## References

For more information about these files, please see the article on [creating a default community health file for your organization](https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization).