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

https://github.com/skygenesisenterprise/documentation

The Sky Genesis Enterprise Github Developers Documentation
https://github.com/skygenesisenterprise/documentation

documentation github wiki

Last synced: about 1 month ago
JSON representation

The Sky Genesis Enterprise Github Developers Documentation

Awesome Lists containing this project

README

          

# GitHub Documentation

Welcome to the central GitHub documentation repository for our organization.
This repository contains all guidelines, standards, and best practices related to the usage, management, and governance of GitHub across our projects.

---

## 📚 Purpose

This repository is designed to:

- Ensure consistent workflows and naming conventions across all repositories.
- Document our GitHub usage policies and security practices.
- Provide onboarding material for new developers and contributors.
- Centralize operational procedures for repository management, CI/CD, and collaboration.

---

## 🗂️ Repository Structure

```

github-documentation/
├── workflows/ # Branching, PR, and CI/CD guidelines
├── security/ # Access control, secrets management, dependency policies
├── conventions/ # Naming, commit messages, release versioning
├── onboarding/ # Setup guide and onboarding process
└── glossary.md # Common terms and acronyms

```

---

## 🧭 Key Topics

- 🔀 Git branching strategy
- 📦 Semantic versioning & release naming
- 🔐 Secrets and access management
- 🤝 Pull request conventions and code review
- 📈 CI/CD best practices with GitHub Actions
- 🛡️ Vulnerability & dependency alert policies

---

## 🚀 Getting Started

If you're new to the team or contributing to a project:

1. Start with [`onboarding/setup-guide.md`](onboarding/setup-guide.md)
2. Review our [contribution rules](.github/CONTRIBUTING.md)
3. Follow the [branching and workflow guide](workflows/branching-strategy.md)

---

## 🧩 Contribution

We encourage internal and external contributions to this documentation. Please read [`CONTRIBUTING.md`](.github/CONTRIBUTING.md) before making any changes.

---

## 📄 License

This repository is licensed under the MIT License unless stated otherwise in individual files.

---

Feel free to open an issue if something is missing or unclear.