From 29a96b55b1fa232da95e7ee24c15e4c4ebf0b659 Mon Sep 17 00:00:00 2001 From: lotyp Date: Wed, 24 Apr 2024 20:02:03 +0300 Subject: [PATCH] docs: initial readme --- .github/CONTRIBUTING.md | 0 README.md | 67 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 5a86cfe..fd6c133 100644 --- a/README.md +++ b/README.md @@ -1 +1,66 @@ -# .github +
+ +
+ + + + WayOfDev Logo + + +
+
+ +
+ +
+Build Status +Commits since latest release +Codecov +Follow on Twitter (X) +
+ +
+ +# Organization Health Files + +This repository contains [community health files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) for the [@wayofdev](https://github.com/wayofdev) organization. + +
+ +## 📦 Changelog + +The maintainers of this project record notable changes to this project in a [changelog](./CHANGELOG.md). + +
+ +## 🤝 Code of Conduct + +We believe in maintaining a respectful environment. All contributors are encouraged to adhere to our [Code of Conduct](./.github/CODE_OF_CONDUCT.md) to ensure a welcoming experience for everyone involved. + +
+ +## ⚖️ License + +[![Licence](https://img.shields.io/github/license/wayofdev/gh-actions?style=for-the-badge&color=blue)](./LICENSE) + +
+ +## 🙌 Want to Contribute? + +Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to: + +- 🤔 Suggest a feature +- 🐛 Report an issue +- 📖 Improve documentation +- 👨‍💻 Contribute to the code + +You are more than welcome. Before contributing, kindly check our [contribution guidelines](.github/CONTRIBUTING.md). + +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org) + +
+ +## 🌐 Social Links + +- **X (Twitter):** Follow our organization [@wayofdev](https://x.com/intent/follow?screen_name=wayofdev) and the author [@wlotyp](https://x.com/intent/follow?screen_name=wlotyp). +- **Discord:** Join our community on [Discord](https://discord.gg/CE3TcCC5vr).